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

:construction: [docs] Move of documentation to vitepress

Open N0W0RK opened this issue 11 months ago • 7 comments

What kind of update does this PR provide? Please check

  • [x] other: Moves documentation to Vitepress.

What is included in your update?

  • Basic Vitepress setup and Homepage.

Additional notes Still WIP Vuepress is EOL and will be replaced by Vitepress. Therefore the switch is reasonable and considering the maintainability of the project necessary. Closes #2884

TODO:

  • [x] Basic Vitepress setup
  • [ ] Include Module documentation
    • [x] Body
    • [ ] Header
  • [ ] Move SFCs
  • [ ] Move Documentation
  • [ ] Configure Internationalisation

N0W0RK avatar Mar 15 '24 02:03 N0W0RK

Maybe a good point to mention #2933 :grin:

Cr4zyc4k3 avatar Mar 19 '24 15:03 Cr4zyc4k3

Not sure if #2933 fits in the scope of this PR. That should maybe be its own pr

N0W0RK avatar Mar 19 '24 17:03 N0W0RK

Just FYI vitepress and yarn workspaces do not like each other. If anyone here has an idea on how to get the build script working, feel free to message me. I opened an issue over at vuejs/viterpess#3677

N0W0RK avatar Mar 21 '24 23:03 N0W0RK

@Cr4zyc4k3 Is there a reason, why the modules template and statusCounter use js files for register or i18n instead of json? Is there a prefered way so everything can be unified.

N0W0RK avatar Apr 09 '24 21:04 N0W0RK

Since the template module is only a template without any real use case I assume nobody noted that until now. The statusCounter module has a register.json. So I assume we can change the /template/register.js to json as well. @jxn-30

Cr4zyc4k3 avatar Apr 10 '24 05:04 Cr4zyc4k3

template does have a .js instead of a json as JSON standard does not allow comments and we're not using json5. However, template is not a module but should give contributors an idea how a module is structured in general, thus it should be ignored for building docs.

jxn-30 avatar Apr 10 '24 11:04 jxn-30

Yes, it came up, because I havent explicitly excluded it yet. However I still think it would be a good Idea to move everything to JSON. This way everything is unified and the template module can be copied, modified and work just like any other module without any special provisions.

N0W0RK avatar Apr 10 '24 12:04 N0W0RK