Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch DIRECTORY-STRUCTURE.md to directories #39

Closed
stockholmux opened this issue Mar 2, 2023 · 0 comments · Fixed by #42
Closed

Switch DIRECTORY-STRUCTURE.md to directories #39

stockholmux opened this issue Mar 2, 2023 · 0 comments · Fixed by #42
Assignees

Comments

@stockholmux
Copy link
Member

In the DIRECTORY-STRUCTURE.md it was articulated that content should go into directories with named markdown files. While this assumption is fine for hugo by itself but the docsy template has some issues rending a proper sidebar using this method. As an example of the improper rending
/os/1.13.x/concepts/updating-bottlerocket.markdown would generate a sidebar listing "Updating Bottlerocket" at both the 1.13.x level and at the concepts level in the sidebar.

If we move to having each piece of content having it's own subdirectory (e.g. /os/1.13.x/concepts/updating-bottlerocket/) and the content itself going into a index.markdown file, Docsy's sidebar renders properly. (This change in the content was made in #38)

As a result, the DIRECTORY-STRUCTURE.md file should be updated to reflect this reality. So, all foo.markdown files should have the .markdown removed except where it's specifically needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants