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

Simplify structure #42

Merged
merged 3 commits into from
Aug 5, 2024
Merged

Simplify structure #42

merged 3 commits into from
Aug 5, 2024

Conversation

s-makin
Copy link
Collaborator

@s-makin s-makin commented Aug 1, 2024

The auto-generated structure was overly complex, but also not structured enough at the same time. To simplify, I have:

  • Added topic folders under each Diataxis level to group content by topic
  • Moved landing pages out of "subsection" folder into relevant diataxis folder
  • Simplified file names and anchor refs where possible
  • Fixed all cross-references to those file names to point to the reference instead
  • Added auto-generated subheading anchors, so we can refer to sub-headings by without having to create anchors in the page

To reviewers
This PR should simplify the docs structure as we already discussed during the doc sprint. Since this PR necessarily changes a lot of small things all over the place, I recommend focusing on the spirit of what it's changing - if there are ways we can simplify it further, or you have strong preferences about filename structure, please let me know. Since the filenames affect the resulting URLs, I'd like them to be changed as little as possible once we're live.

Not all links pointing to files have been changed - only the ones affected by my renaming/moving of files (this is intentional).

@s-makin s-makin merged commit 155c4e8 into canonical:main Aug 5, 2024
1 check passed
@s-makin s-makin deleted the simplify-structure branch August 5, 2024 08:22
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 this pull request may close these issues.

1 participant