Commit Graph

9 Commits

Author SHA1 Message Date
DS
e67c738314 doc: update fetchzip docs, add examples and follow conventions
With updates in a doc team meeting with Valentin, Silvan and Johannes :)
2024-04-11 17:09:41 +02:00
Daniel Sidhion
c9c7d2f237
doc: document fetchurl more completely, follow doc conventions (#300429)
* doc: document fetchurl more completely, follow doc conventions

Co-authored-by: Johannes Kirschbauer <hsjobeki+github@gmail.com>
2024-04-04 14:12:42 +02:00
Daniel Sidhion
0decb324b3
doc: improve fetchers overview, deduplicate readme content, follow doc conventions (#297654)
* doc: improve fetchers overview, deduplicate readme content

* Improve caveat explanation and some fetchurl content

* move out consumer docs on source fetching

* move note on mirror URLs to the relevant section

this may be better suited for the `fetchurl` reference, but it's probably better to
just render that information into the manual. for now, because
- contributor documentation encourages mirrors
- we can expect contributors to dig into the source
- linking source files is trivial in in-code documentation
we leave it there.

* move instructions for updating hashes to the manual

* Add more clarity on text, reorganise source hash methods

---------

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Dominic Mills-Howell <dominic.millz27@gmail.com>
Co-authored-by: lolbinarycat <dogedoge61+github@gmail.com>
2024-04-03 08:18:11 +02:00
Janne Heß
bc5ee2b8f8 treewide: Switch markdown placeholder from "..." to <...>
We use angle brackets since they look a lot like a placeholder while
also being valid nix code, as suggested by roberth here: https://github.com/NixOS/nixpkgs/pull/299554#discussion_r1541797970
2024-03-28 09:28:12 +01:00
Janne Heß
fcc95ff817 treewide: Fix all Nix ASTs in all markdown files
This allows for correct highlighting and maybe future automatic
formatting. The AST was verified to work with nixfmt only.
2024-03-28 09:28:12 +01:00
Janne Heß
bc77c7a973 treewide: Mark Nix blocks in markdown as Nix
This should help us with highlighting and future formatting.
2024-03-28 09:28:12 +01:00
Robert Hensing
e99021ff75 trivial-builders: Deduplicate docs
I didn't have the opportunity to do all work at once, so I've added
TODOs to bring attention to the situation.
2024-03-11 11:33:14 +01:00
Matthieu Coudron
0c3eca2682
doc/fetchers: document downloadToTemp for fetchurl (#288762)
* doc/fetchers: document downloadToTemp for fetchurl

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-02-22 16:10:21 +01:00
Yueh-Shun Li
9963ad5c5f doc: builders -> build helpers to reduce ambigualty 2023-11-07 19:58:53 +00:00