Automatically generate the left-side docs menu
For /docs/* URLs, we display a menu on the left-hand side that is currently hard-coded in src/lib/contents/docs/menu.ts.
In #1393, we move the documentation to a different repository and updating the menu.ts file in the website repo is no longer a convenient workflow. We need to auto-generate the menu based on frontmatter available in the documentation Markdown files.
Tasks
- [ ] Remove all unused frontmatter properties in
gitpod/docs/**/*.md. - [ ] Add a new
statusfrontmatter property to mark menu items as "Beta" or "Soon" (possibly others in the future). See https://www.gitpod.io/docs/editors for how it will be used - [x] Write a new
handle*function insrc/hooks.tsto parse the documentation frontmatter and generate the menu. - [x] Update the
getSession()function insrc/hooks.tsto expose the generated docs menu. - [ ] Update
gitpod/docs/__layout.svelteto use the generated docs menu.- [ ] Test on mobile
- [ ] Test on desktop
- [ ] Remove
src/lib/contents/docs/menu
@Cahllagerfeld is this issue still valid?
It is in regards for versioning, I can link that issue to the relevant PR 👍
It's not implemented in the described way though
I'd love to sync on this before merging though
👍 One for tomorrow's daily sync :)
@Cahllagerfeld is this issue still relevant? Can it be closed? Should it be prioritized or moved to the backlog? 🙏
That's not relevant anymore, closing it