search

nix-community / ethereum.nix

Nix packages and NixOS modules for the Ethereum ecosystem. [maintainers=@aldoborrero,@brianmcgee,@selfuryon]
https://nix-community.github.io/ethereum.nix/
MIT License
102 stars 36 forks source link

How best to document everything? #50

Closed brianmcgee closed 1 year ago

brianmcgee commented 1 year ago

The readme is only getting bigger. We should have a more robust set of docs. I'm open to suggestions.

aldoborrero commented 1 year ago

I think it's time to use either mdbook or docsify.

aldoborrero commented 1 year ago

We will stick with mdbook as it's quite simplistic to use.

brianmcgee commented 1 year ago

I'd like to throw MkDocs into the mix, I see it around on a lot of nix projects.

brianmcgee commented 1 year ago

After speaking with the Numtide guys they are standardising on mkdocs. I had a look and it seems to be feature rich. An added bonus is I can just copy some of the setup and layout from projects like Treefmt which I've already done in #147