LSSM-V.4 icon indicating copy to clipboard operation
LSSM-V.4 copied to clipboard

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

Open jxn-30 opened this issue 1 year ago • 3 comments

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 avatar Feb 08 '24 09:02 jxn-30

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

N0W0RK avatar Mar 12 '24 14:03 N0W0RK

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.

jxn-30 avatar Mar 12 '24 14:03 jxn-30

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

N0W0RK avatar Mar 12 '24 18:03 N0W0RK