Add a documentation site #232
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
barrucadu
force-pushed
the
documentation
branch
4 times, most recently
from
7b823c7 to
cfa3849
Compare
This necessitated a little refactoring, splitting the options declarations out of the config so that I don't need to somehow evaluate all the standard nixos modules just to generate documentation for my stuff. For now, the script treats missing documentation as a warning, not an error. Once everything is documented, this will change.
barrucadu
force-pushed
the
documentation
branch
from
cfa3849 to
37de90f
Compare
barrucadu
force-pushed
the
documentation
branch
from
0363d34 to
cc5f131
Compare
barrucadu
force-pushed
the
documentation
branch
from
be46ebf to
767badd
Compare
barrucadu
force-pushed
the
documentation
branch
3 times, most recently
from
ee048fa to
089d996
Compare
barrucadu
force-pushed
the
documentation
branch
from
089d996 to
68793f8
Compare
barrucadu
force-pushed
the
documentation
branch
from
0536420 to
807aa37
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a documentation site, which will be deployed to https://nixfiles.docs.barrucadu.co.uk
I've written basic documentation for all the modules, options, and packages; moved some stuff from the README to other pages; and fixed inconsistencies in option naming. I've spotted other improvements that can be made, but those will come in subsequent refactoring PRs.