Flatten the Cookbook and Reference sections of the nav #336
Conversation
This file contains hidden or 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
github-actions
bot
added
the
documentation
djsauble
force-pushed
the
djsauble/ia_tweaks
branch
from
7c77d08 to
f2f53d5
Compare
djsauble
force-pushed
the
djsauble/ia_tweaks
branch
from
c7f27a7 to
d9051b8
Compare
djsauble
force-pushed
the
djsauble/ia_tweaks
branch
from
d9051b8 to
f44238a
Compare
zmitchell
requested changes
Oct 1, 2025
There was a problem hiding this comment.
Two things:
- You'll need to add redirects to
mkdocs.yml(at the very bottom) so we don't break existing links to the documentation. - (Personal preference) I prefer the URL slug for man pages to be
/man/flox-*so it looks like the command you'd type in your terminal. You can do that by just renaming the directory, but you can keep theManualsidebar name.
djsauble
force-pushed
the
djsauble/ia_tweaks
branch
from
ab8ad4a to
1bb4c9b
Compare
djsauble
force-pushed
the
djsauble/ia_tweaks
branch
from
1bb4c9b to
b3d4817
Compare
|
The link checker is getting rate-limited by |
zmitchell
reviewed
Oct 1, 2025
check_links.sh
Outdated
| -nv \ | ||
| --remap "https://flox.dev/docs file://$PWD/site" \ | ||
| --exclude "bash/manual/html_node" \ | ||
| --exclude "bash/man/html_node" \ |
There was a problem hiding this comment.
Is this a search and replace error?
| redirect_maps: | ||
| 'concepts/manifest.md': 'concepts/environments.md#manifesttoml' | ||
| 'install-flox.md': 'install-flox/install.md' | ||
| 'reference/command-reference/flox-activate.md': 'man/flox-activate.md' |
There was a problem hiding this comment.
Did you check whether there was a glob syntax you could use instead of listing these individually?
There was a problem hiding this comment.
Doesn't seem to be. The redirects plugin iterates through redirect_maps and uses mkdocs.utils.is_markdown_file to check whether each entry ends in .md.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.