Commit Graph

19 Commits

Author SHA1 Message Date
terru
cc5b30542b
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.
2024-04-19 17:27:58 +02:00
Alejandro Sanchez Medina
a63b9c15c9 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>
2024-01-25 16:33:35 +01:00
DS
a731d0cb71 doc: update conventions with repl examples and function (in|out)puts 2024-01-25 07:17:30 -08:00
Valentin Gagarin
848f518363
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>
2024-01-25 16:06:24 +01:00
Valentin Gagarin
f159a340ff
Merge pull request #281211 from fricklerhandwerk/documentation-conventions
doc: reword documentation conventions
2024-01-15 22:38:15 +01:00
Valentin Gagarin
0fe7b4c389 doc: reword documentation conventions 2024-01-15 21:04:12 +01:00
Valentin Gagarin
f1601b35e7 doc: mention new documentation-reviewers subteam 2024-01-15 21:01:21 +01:00
DS
016680fcf6 doc: add documentation conventions to keep a consistent style 2024-01-04 15:44:05 -08:00
Robert Hensing
8d20c2011e
Merge pull request #272183 from infinisil/nixpkgs-reference
doc: Rename to Nixpkgs reference manual and restate purpose
2023-12-10 07:07:20 +01:00
Silvan Mosberger
f5dafbfa83 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>
2023-12-08 01:26:31 +01:00
Silvan Mosberger
4769458228 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
2023-12-06 03:51:39 +01:00
DS
e93a3d7b58 doc: separate commit header conventions for each area, info on docs changes. 2023-11-13 20:41:08 -08:00
Alejandro Sánchez Medina
4c3def1ae8
doc manuals: change reference link to nixos-render-docs
Co-authored-by: Silvan Mosberger <github@infinisil.com>
2023-08-29 16:07:41 +02:00
Alejandro Sanchez Medina
60d879e257 doc manuals: add reference to nixos-render-docs 2023-08-24 19:24:07 +02:00
Silvan Mosberger
553daaed73 doc/README.md: Cleanup 2023-08-14 04:46:16 +02:00
Silvan Mosberger
74b17a515f 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.
2023-08-13 22:04:55 +02:00
Silvan Mosberger
d70091c3ad Create unified markdown files for contributing docs 2023-08-13 21:54:50 +02:00
Robert Hensing
b53965f1d2 doc/README.md: Add more links 2021-03-06 12:35:33 +01:00
Robert Hensing
0a4a486096 doc/README.md: init 2021-03-04 18:10:39 +01:00