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

refactor: Implement new site structure #180

Merged
merged 28 commits into from
Feb 6, 2024

Conversation

programmiri
Copy link
Contributor

@programmiri programmiri commented Feb 1, 2024

Description

This PR restructures the structure and navigation for our docs.

Decisions made with this PR

  • structure in our directories matches the structure we apply in sidebar.js, that way navigation in files is more intuitive
  • sidebar.js does not included categories with autogenerated-index other than for releases. This makes it more comfortable to organise the order of documents.
  • we only include an entry index page for a category if it's needed, because it provides additional information or a needed overview

PR includes:

First bunch of commits is for creating new categories and move existing pages.

The commits are named Add new category <CATEGORY_NAME>

Each commit includes:

  • creating of the new dir
  • moving files and renaming if needed
  • a change in current-routes.json that reflect the changes for the routes that are generated in build
  • an entry in _redirects based on those route changes that redirect old links to new ones on the server

All commits on Feb 5, 2024 include smaller clean up and update tasks like:

  • moving doc pages that where not in the original move
  • removing unneeded directories and elements
  • updating links
  • adding a script to check for that all files in sidebar.js are actually there and no files in docs are missing in sidebar.js
  • updating the markdown link checker

Out of scope for this PR

Copy link

cloudflare-workers-and-pages bot commented Feb 1, 2024

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 26ea9e6
Status: ✅  Deploy successful!
Preview URL: https://ab7110b1.klaw-docs.pages.dev
Branch Preview URL: https://138-restructure-all-doc-page.klaw-docs.pages.dev

View logs

Signed-off-by: Mirjam Aulbach <[email protected]>
@programmiri programmiri force-pushed the 138-restructure-all-doc-pages branch from 9cc81ad to 8e012c8 Compare February 1, 2024 13:53
Signed-off-by: Mirjam Aulbach <[email protected]>
@programmiri programmiri force-pushed the 138-restructure-all-doc-pages branch 3 times, most recently from 29b08f8 to 38e2bc7 Compare February 2, 2024 10:55
@programmiri programmiri force-pushed the 138-restructure-all-doc-pages branch from 38e2bc7 to cb7e2f2 Compare February 2, 2024 11:16
@programmiri programmiri force-pushed the 138-restructure-all-doc-pages branch from a50b68c to 179f772 Compare February 2, 2024 16:16
@programmiri programmiri force-pushed the 138-restructure-all-doc-pages branch from 4e746cb to 78019ef Compare February 5, 2024 08:30
@programmiri programmiri force-pushed the 138-restructure-all-doc-pages branch from 34a9660 to 9b63dcd Compare February 5, 2024 12:48
…kflows/topic. Delete unneeded files/dirs.

Signed-off-by: Mirjam Aulbach <[email protected]>
Signed-off-by: Mirjam Aulbach <[email protected]>
Signed-off-by: Mirjam Aulbach <[email protected]>
@programmiri programmiri force-pushed the 138-restructure-all-doc-pages branch 2 times, most recently from 998b496 to 740b0a5 Compare February 5, 2024 19:56
@programmiri programmiri force-pushed the 138-restructure-all-doc-pages branch from 740b0a5 to 6def9fc Compare February 5, 2024 20:02
Signed-off-by: Mirjam Aulbach <[email protected]>
@programmiri programmiri self-assigned this Feb 5, 2024
@programmiri programmiri marked this pull request as ready for review February 5, 2024 20:24
Copy link
Contributor

@muralibasani muralibasani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me.

@programmiri programmiri merged commit 16fd557 into main Feb 6, 2024
5 checks passed
@programmiri programmiri deleted the 138-restructure-all-doc-pages branch February 6, 2024 12:47
@programmiri programmiri mentioned this pull request Feb 7, 2024
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.

2 participants