Document each store type on its own page #9504
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
fricklerhandwerk
requested review from
thufschmitt,
roberth and
edolstra
as code owners
github-actions
bot
added
documentation
new-cli
8 tasks
roberth
reviewed
Nov 30, 2023
| # FIXME: this is a horrible hack to keep `nix help-stores` working. | ||
| # the correct answer to this is to remove that command and replace it | ||
| # by statically generated manpages or the output of something like `nix | ||
| # store info <store type>`. |
There was a problem hiding this comment.
Suggested change
| # store info <store type>`. | |
| # store docs <store type>`. |
I'd say info is for dumping info about instances of the noun rather than docs about the concept (or subtypes).
There was a problem hiding this comment.
I think that's an intentional difference :)
There was a problem hiding this comment.
Yeah, these are just ramblings.
| filename = "${slug}.md"; | ||
| page = showStore { inherit name slug; } storeInfo.${name}; | ||
| }) | ||
| (attrNames storeInfo); |
There was a problem hiding this comment.
off-topic: We could get ourselves a lib after implementing subtree fetching.
Ericson2314
approved these changes
Nov 30, 2023
There was a problem hiding this comment.
From my phone, looks good modulo "slug" shadowing @roberth found.
fricklerhandwerk
force-pushed
the
store-implementation-per-page
branch
from
829d3f5
to
e25cffe
Compare
This makes for more useful manual table of contents, that displays the information at a glance. The `nix help-stores` command is kept as-is, even though it will show up in the manual with the same information as these pages due to the way it is written as a "`--help`-style" command. Deciding what to do with that command is left for a later PR. This change also lists all store types at the top of the respective overview page. Co-authored-by: John Ericson <John.Ericson@Obsidian.Systems
fricklerhandwerk
force-pushed
the
store-implementation-per-page
branch
from
e25cffe
to
78ed929
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.
@Ericson2314 Review and rework of #8781
Motivation
This makes for more useful manual table of contents, that displays the
information at a glance.
Context
This change also lists all store types at the top of the respective overview page.
The
nix help-storescommand is kept as-is, even though it will show upin the manual with the same information as these pages due to the way it
is written as a "
--help-style" command. Deciding what to do with thatcommand is left for a later PR.
This work is sponsored by Antithesis ✨
Priorities
Add 👍 to pull requests you find important.