summaryrefslogtreecommitdiff
path: root/doc/README.md (follow)
Commit message (Expand)AuthorAgeFilesLines
* treewide: fix typosBen Siraphob2026-01-131-2/+2
* doc: add note on updating existing content to one-sentence-one-lineValentin Gagarin2025-12-151-0/+4
* Merge master into staging-nextnixpkgs-ci[bot]2025-10-021-0/+28
|\
| * docs: add clarifying explanation about reference documentation•••apply @roberth suggestion Co-authored-by: Robert Hensing <roberth@users.noreply.github.com> Johannes Kirschbauer2025-10-021-0/+28
* | doc: fix typosBen Siraphob2025-09-091-2/+2
|/
* doc: fix typosBen Siraphob2025-08-271-3/+3
* **/README.md: one sentence per line•••As documented in doc/README.md. Wolfgang Walther2025-06-291-10/+21
* doc: point manual contributing guides to devmode's README (#411326)•••There's quite a bit of pingpong redirection with Nixpkgs and NixOS manual utilities. Since devmode was lacking a README, the descriptive text is moved there and it's referenced by both manuals.Alejandro Sánchez Medina2025-06-161-5/+1
* docs: add instructions to load development utilities•••Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Alejandro Sánchez Medina2025-05-201-1/+21
* doc: Cross-reference roles syntax doc & implementation•••reasoning: - (doc -> code) make it easier to find where those are implemented - to get easier insight if/what a specific renderer does with it - in case one wants to improve them, which seems likely as they are rather Nix/NixOS-specific - (took me too long to find their implementation) - (code -> doc) ensure changes to the code can be reflected in the doc - code authors might not know about the reference documentation or how to find it Felix Stupp2025-01-151-0/+1
* doc/README.md: Mention the alphabetical sorting in the documentation•••Signed-off-by: Fernando Rodrigues <alpha@sigmasquadron.net> Fernando Rodrigues2024-12-101-0/+1
* nixos-render-docs: init redirects system•••Co-authored-by: Valentin Gagarin <valentin@gagarin.work> GetPsyched2024-11-151-1/+7
* doc/README: fix nixos-render-docs link•••This was unintentionally broken in 571c71e6f73af34a229414f51585738894211408 GetPsyched2024-11-151-1/+1
* doc/README: More anchors to link to•••Converts that long list into headers such that they can be linked to. Silvan Mosberger2024-10-101-84/+96
* Docs: highlight structure vision (#342978)•••Co-authored-by: Valentin Gagarin <valentin@gagarin.work>Johannes Kirschbauer2024-09-191-3/+13
* treewide: Fix or remove some markdown links•••Found using https://github.com/serokell/xrefcheck, which unfortunately can't trivially be enforced in CI because we also have the manual markdown files that need post-processing to be valid Silvan Mosberger2024-09-031-1/+1
* Merge pull request #329400 from NixOS/doc-function-inputs•••doc/README: Add function Inputs guidelinesRobert Hensing2024-08-111-8/+25
|\
| * doc/README: Add function Inputs guidelinesorigin/doc-function-inputsRobert Hensing2024-07-231-8/+25
* | treewide: fix doc typos•••Done with `fd \\\.md$ . --type f -x typos --write-changes` Peder Bergebakken Sundt2024-07-261-1/+1
|/
* Remove mentions of documentation-reviewers team•••See also https://github.com/NixOS/nix.dev/pull/978 Silvan Mosberger2024-05-131-1/+1
* doc/gnome: Use `wrapGApps*` hook for referring to the hook familyJan Tojnar2024-04-271-1/+1
* doc: remove links to docbook documentation (#305328)•••There appears to be no clear reason why docbook should be referenced here, except perhaps for historical reasons from when the manual still used docbook.terru2024-04-191-6/+6
* doc: Update manuals bespoke syntax•••doc: add figure definition to bespoke syntax reference doc: add example definition to bespoke syntax reference doc: add footnote definition to beskpoke syntax reference The usage of footnotes in the manuals is not the one documented in markdown-it-py: https://python-markdown.github.io/extensions/footnotes/ doc: add inline comment definition to beskpoke syntax reference doc: add typographic replacements to beskpoke syntax reference doc: Fix rendering of bespoke syntax reference doc: remove references to DocBook in the NixOS manual doc: add entry on lack of HTML support doc: Minor improvement doc: update typographic replacements entry in beskpoke syntax reference doc: add link reference definitions to beskpoke syntax reference doc: fix footnote definition in beskpoke syntax reference doc: Minor improvements from code review Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Alejandro Sanchez Medina2024-01-251-0/+78
* doc: update conventions with repl examples and function (in|out)putsDS2024-01-251-0/+57
* doc: add types to template (#281220)•••* doc: add types to template * mention types explicitly * use separator that allows for more items in the type declaration Co-authored-by: Daniel Sidhion <DanielSidhion@users.noreply.github.com> --------- Co-authored-by: Daniel Sidhion <DanielSidhion@users.noreply.github.com>Valentin Gagarin2024-01-251-5/+5
* Merge pull request #281211 from fricklerhandwerk/documentation-conventions•••doc: reword documentation conventionsValentin Gagarin2024-01-151-9/+13
|\
| * doc: reword documentation conventionsValentin Gagarin2024-01-151-9/+13
* | doc: mention new documentation-reviewers subteamValentin Gagarin2024-01-151-0/+4
|/
* doc: add documentation conventions to keep a consistent styleDS2024-01-041-0/+64
* Merge pull request #272183 from infinisil/nixpkgs-reference•••doc: Rename to Nixpkgs reference manual and restate purposeRobert Hensing2023-12-101-6/+10
|\
| * doc: Rename to Nixpkgs reference manual and state purpose•••For the time being, we're moving towards https://nix.dev/ containing all tutorials and guides. The Nixpkgs manual is reinforced to be a _reference_ manual. While it's not just reference for now, that's what the docs team is working towards. This commits rewrites the Nixpkgs manual introduction to reflect that and point to some more useful links. The contribution docs are updated similarly so it's not missed. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Co-authored-by: Robert Hensing <roberth@users.noreply.github.com> Silvan Mosberger2023-12-081-6/+10
* | CONTRIBUTING.md: Update markdown emphasising syntax•••GitHub supported special markdown syntax for emphasising blocks for some time. This was however a beta feature, and still is, so it's subject to changes. Recently such a change happened: The syntax is different now. See https://github.com/orgs/community/discussions/16925 for more information Silvan Mosberger2023-12-061-1/+1
|/
* doc: separate commit header conventions for each area, info on docs changes.DS2023-11-131-0/+21
* doc manuals: change reference link to nixos-render-docs•••Co-authored-by: Silvan Mosberger <github@infinisil.com>Alejandro Sánchez Medina2023-08-291-1/+1
* doc manuals: add reference to nixos-render-docsAlejandro Sanchez Medina2023-08-241-0/+1
* doc/README.md: CleanupSilvan Mosberger2023-08-141-69/+57
* doc/contributing-to-documentation: Rough move to new contribution doc files•••Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided. Silvan Mosberger2023-08-131-0/+116
* Create unified markdown files for contributing docsSilvan Mosberger2023-08-131-2/+1
* doc/README.md: Add more linksRobert Hensing2021-03-061-0/+4
* doc/README.md: initRobert Hensing2021-03-041-0/+8