about summary refs log tree commit diff
path: root/doc/README.md
AgeCommit message (Collapse)AuthorFilesLines
2024-05-13Remove mentions of documentation-reviewers teamSilvan Mosberger1-1/+1
See also https://github.com/NixOS/nix.dev/pull/978
2024-04-27doc/gnome: Use `wrapGApps*` hook for referring to the hook familyJan Tojnar1-1/+1
2024-04-19doc: remove links to docbook documentation (#305328)terru1-6/+6
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.
2024-01-25doc: Update manuals bespoke syntaxAlejandro Sanchez Medina1-0/+78
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>
2024-01-25doc: update conventions with repl examples and function (in|out)putsDS1-0/+57
2024-01-25doc: add types to template (#281220)Valentin Gagarin1-5/+5
* 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>
2024-01-15Merge pull request #281211 from fricklerhandwerk/documentation-conventionsValentin Gagarin1-9/+13
doc: reword documentation conventions
2024-01-15doc: reword documentation conventionsValentin Gagarin1-9/+13
2024-01-15doc: mention new documentation-reviewers subteamValentin Gagarin1-0/+4
2024-01-04doc: add documentation conventions to keep a consistent styleDS1-0/+64
2023-12-10Merge pull request #272183 from infinisil/nixpkgs-referenceRobert Hensing1-6/+10
doc: Rename to Nixpkgs reference manual and restate purpose
2023-12-08doc: Rename to Nixpkgs reference manual and state purposeSilvan Mosberger1-6/+10
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>
2023-12-06CONTRIBUTING.md: Update markdown emphasising syntaxSilvan Mosberger1-1/+1
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
2023-11-13doc: separate commit header conventions for each area, info on docs changes.DS1-0/+21
2023-08-29doc manuals: change reference link to nixos-render-docsAlejandro Sánchez Medina1-1/+1
Co-authored-by: Silvan Mosberger <github@infinisil.com>
2023-08-24doc manuals: add reference to nixos-render-docsAlejandro Sanchez Medina1-0/+1
2023-08-14doc/README.md: CleanupSilvan Mosberger1-69/+57
2023-08-13doc/contributing-to-documentation: Rough move to new contribution doc filesSilvan Mosberger1-0/+116
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.
2023-08-13Create unified markdown files for contributing docsSilvan Mosberger1-2/+1
2021-03-06doc/README.md: Add more linksRobert Hensing1-0/+4
2021-03-04doc/README.md: initRobert Hensing1-0/+8