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

🚧 [docs] Move of documentation to vitepress #2951

Draft
wants to merge 4 commits into
base: dev
Choose a base branch
from

Conversation

N0W0RK
Copy link

@N0W0RK N0W0RK commented Mar 15, 2024

What kind of update does this PR provide? Please check

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:

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

@N0W0RK N0W0RK force-pushed the rewrite/docs branch 2 times, most recently from 7d68f17 to ab43840 Compare March 16, 2024 17:09
@N0W0RK N0W0RK mentioned this pull request Mar 19, 2024
@Cr4zyc4k3
Copy link
Collaborator

Maybe a good point to mention #2933 😁

@N0W0RK
Copy link
Author

N0W0RK commented Mar 19, 2024

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

New documentation resides in .
After full transfer, new documentation will be placed in  and buildscripts will be adapted.
@N0W0RK
Copy link
Author

N0W0RK commented Mar 21, 2024

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

Rewrite rules compile the Markdown files into the correct directory structure while leaving them next to the source.
 Is vitepress syntax and has to be sourrounded by a span. ESLint rules are modifed accordingly.
Asset links are cleaned up and somewhat unified. WIP
Dynamic links to Issue LSS-Manager#15 and FontAwesome are made static.
@Cr4zyc4k3 Cr4zyc4k3 added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 7, 2024
@N0W0RK
Copy link
Author

N0W0RK commented Apr 9, 2024

@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.

@Cr4zyc4k3
Copy link
Collaborator

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

@jxn-30
Copy link
Member

jxn-30 commented Apr 10, 2024

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.

@N0W0RK
Copy link
Author

N0W0RK commented Apr 10, 2024

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.

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

Successfully merging this pull request may close these issues.

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