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

Investigate migration to VitePress #174

Closed
zoey-kaiser opened this issue Apr 18, 2024 · 2 comments · Fixed by #186
Closed

Investigate migration to VitePress #174

zoey-kaiser opened this issue Apr 18, 2024 · 2 comments · Fixed by #186
Labels
enhancement New feature or request

Comments

@zoey-kaiser
Copy link
Member

Describe the feature

As Docus is now abandoned (nuxt-themes/docus#1016), we will not receive any updates or security patches for our documentation software.

Therefore, we want to look into migrating to vitepress. For this, we need to estimate how long it will take and what the benefits would be, to decide if it makes sense!

Additional information

No response

@zoey-kaiser zoey-kaiser added the enhancement New feature or request label Apr 18, 2024
@brenoepics
Copy link

I've been taking a look at the repo, it would be necessary to change the routes, the md files are mostly ok besides some alert syntax... just the blog and some other things that needs changes to make components in a way that looks good on Vitepress, the server part apparently isn't used as it only has this healthcheck

also, I can help with vp migration.

@zoey-kaiser
Copy link
Member Author

zoey-kaiser commented Apr 28, 2024

Hi @brenoepics 👋

Thanks for doing an initial investigation! I think the main migration of the documentation should be fairly straightforward, as you pointed out! Do you know how easy it would be to migrate the LandingPage of the documentation?

The difficulties I still see are:

  • Migrate the landing page
  • Redesigning the landing page to be more inline with the style of Vitpress
  • Figure out versioning of the documentation to allow us to continue splitting the docs of major releases of the modules
  • Ensuring all previous documentation routes still match up with the new docs, to ensure old links people may find still work

Feel free to continue the investigation, however for now, we are prioritizing some updates on the modules themselves and would potentially revisit the documentation migration in the summer!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
2 participants