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.

Sign up for GitHub

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

Jump to bottom

[docs] evaluate switching to VitePress and rewrite the docs system #2884

Open
jxn-30 opened this issue Feb 8, 2024 · 3 comments · May be fixed by #2951
Open

[docs] evaluate switching to VitePress and rewrite the docs system #2884

jxn-30 opened this issue Feb 8, 2024 · 3 comments · May be fixed by #2951
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jxn-30
Copy link
Member

jxn-30 commented Feb 8, 2024

docs are currently built up very hacky, a rewrite would probably be a good idea to increase maintainability. While doing this step, a migration to VitePress could be considered.

Things I would like to keep in mind during this process

  • Default module pages for all Docs-Languages. Using the english module name and description when translation does not exist for that language (also a note which languages this wiki page exists in). This is also current state
  • either merging the 3 english languages (GB, US, AU) or using symlinks to avoid having the same content copied over and over
  • no usage of weird child-process thingies!
  • updated structure at result is allowed but old links (/{lang}/modules/{module}/) need to stay reachable (or maybe redirected to new ones). Also the "intended" links will have to be updated in LSSM then
@jxn-30 jxn-30 added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 8, 2024
jxn-30 added a commit that referenced this issue Feb 8, 2024
@jxn-30
🔧 [renovate] disable vuepress updates in favor of #2884
d175e41
@jxn-30 jxn-30 mentioned this issue Feb 13, 2024
Merged
6 tasks
@jxn-30 jxn-30 mentioned this issue Mar 12, 2024
Closed
@N0W0RK
Copy link

N0W0RK commented Mar 12, 2024

As VitePress is based on Vue 3, the whole project would have to migrated. Are there any plans on that?

@jxn-30
Copy link
Member Author

jxn-30 commented Mar 12, 2024

There are plans to migrate LSSM V4 to vue3 but it unfortunately is a log migration process.
docs however are seperate from LSSM itself and thus already run on vue3.

@N0W0RK
Copy link

N0W0RK commented Mar 12, 2024

I see. Haven't worked much with node. I will have a look into that.

@N0W0RK N0W0RK linked a pull request Mar 15, 2024 that will close this issue
Draft
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

🚧 [docs] Move of documentation to vitepress N0W0RK/LSSM-V.4
2 participants
@N0W0RK @jxn-30