Skip to content

doc(manuals): organize content#1954

Closed
ju1m wants to merge 9 commits into
ngi-nix:mainfrom
ju1m:manuals
Closed

doc(manuals): organize content#1954
ju1m wants to merge 9 commits into
ngi-nix:mainfrom
ju1m:manuals

Conversation

@ju1m
Copy link
Copy Markdown

@ju1m ju1m commented Jan 12, 2026

This PR introduces a demo of what could be used to make manuals for NGIpkgs, currently:

State

  • Two manuals:
    • a User's Manual
    • a Contributor's Manual
  • Each manual is structured with the 4 Diátaxis categories:
    • Tutorials,
    • How-to,
    • Explanations,
    • References
  • Plus:
    • Release notes

Build and read with:

$ nix -L build -f . manuals.singlehtml
$ xdg-open result/index.html

$ nix -L build -f . manuals.html
$ xdg-open result/index.html

$ nix -L build -f . manuals.latexpdf
$ xdg-open result/NGIpkgs_Manuals.pdf

Related

RoadMap

  • Host the HTML rendition somewhere online.

@ju1m
Copy link
Copy Markdown
Author

ju1m commented Jan 13, 2026

Comment thread manuals/User/What_is/NGIpkgs.md Outdated
provides:
- packages (`pkgs`) recipes
in [Nix-the-language](https://nix.dev/tutorials/nix-language.html)
to install softwares and all their dependencies using [a Nix-package-manager](#User_How_to_install_Nix)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

softwares feels wrong so I looked it up, looks like it needs to be software everwhere.

@ju1m ju1m closed this Feb 19, 2026
@ju1m ju1m deleted the manuals branch February 19, 2026 10:15
@github-project-automation github-project-automation Bot moved this to Done in Nix@NGI Feb 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants