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

Meta: use vitepress for docs #2927

Closed
wants to merge 3 commits into from
Closed

Meta: use vitepress for docs #2927

wants to merge 3 commits into from

Conversation

KaelWD
Copy link

@KaelWD KaelWD commented Aug 19, 2024

The current documentation site is annoying to use as it has no global navigation links and performs a full refresh on page change. This PR renders the docs with vitepress which comes with SPA navigation, a dark theme, searching, and a sidebar with links to every other page instead of having to go back through the index.

Screenshot_20240820_235958

@Ms2ger
Copy link
Collaborator

Ms2ger commented Aug 20, 2024

Hi! Could you give a bit more background on what the goal of this PR is?

@KaelWD KaelWD changed the title Meta: use vitepress Meta: use vitepress for docs Aug 20, 2024
@KaelWD
Copy link
Author

KaelWD commented Aug 20, 2024

I've added a PR description. This was initially for my own use because I was frustrated with the current site and there doesn't seem to be any progress on #1449 yet.

@ptomato
Copy link
Collaborator

ptomato commented Aug 23, 2024

I'm hesitant about this because I'm not familiar with Vitepress and would not be able to debug it. But on the other hand, it does solve an actual problem: the lack of navigation sidebar is annoying in the current docs and has been for a long time.

Does Vitepress have any mode where it can just generate the site with all the assets in place such that they can be loaded with relative paths, as the current site does? Not having to spin up a HTTP server with vitepress dev when developing the docs locally would solve one of my hesitations.

@KaelWD
Copy link
Author

KaelWD commented Aug 25, 2024

That doesn't seem to be supported unfortunately: vuejs/vitepress#3057

@ptomato
Copy link
Collaborator

ptomato commented Sep 19, 2024

@KaelWD Thanks for contributing this. We discussed it in the Temporal meeting today and unfortunately decided not to merge it. Basically we see it as somewhat of a risk to change the docs framework at this point. However it's clear there is a need for better navigation features, especially a sidebar, and so a few of us volunteered to look into implementing a sidebar in the current static website.

@ptomato ptomato closed this Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants