docs: use NDG #54

New issue

Open

opened 2026-04-26 12:26:38 +03:00 by c · 0 comments

c commented

2026-04-26 12:26:38 +03:00

Owner

The current system uses two branches; one branch for code, the other as the website.
I am too lazy to switch branches and update the website each time.

Move documentation to markdown files in a docs/ directory. Documentation can then be generated and served via NDG.
Additionally, package it for Nix and expose it at .#docs. This way, I can selfhost the docs...

Possibly, later on, the docs markdown files themselves could be generated from the code itself. I believe this is possible, but perhaps this is for a later, separate issue.

The current system uses two branches; one branch for code, the other as the website. I am too lazy to switch branches and update the website each time. Move documentation to markdown files in a docs/ directory. Documentation can then be generated and served via [NDG](https://github.com/feel-co/ndg). Additionally, package it for Nix and expose it at .#docs. This way, I can selfhost the docs... Possibly, later on, the docs markdown files themselves could be generated from the code itself. I believe this is possible, but perhaps this is for a later, separate issue.

c added the

documentation

label

2026-04-26 12:26:38 +03:00