Skip to content
This repository has been archived by the owner on Dec 27, 2024. It is now read-only.

feat: documentation website #277

Merged
merged 22 commits into from
Oct 15, 2024
Merged

feat: documentation website #277

merged 22 commits into from
Oct 15, 2024

Conversation

mtdvlpr
Copy link
Contributor

@mtdvlpr mtdvlpr commented Oct 14, 2024

I've created a basic setup for a documentation website using VitePress. VitePress is the official documentation builder of Vue. I've added a home, about and faq page and setup the internationalization. The theme/styling can be customized to align with M³ styling. You can easily work on the website locally with the docs:dev script. It has built-in search, light/dark and responsiveness.

For deployment, perform the steps at https://vitepress.dev/guide/deploy#github-pages

I've also optimized the Electron dependencies (see Quasar Docs for more info). When Electron uses a new dependency, it should be explicitly added in quasar.config.js, so that only the necessary dependencies are included in the production build.

@sircharlo
Copy link
Owner

Alright! This is great stuff!!
Let's give it a whirl.

@sircharlo sircharlo merged commit 1ef9ef6 into sircharlo:main Oct 15, 2024
2 of 3 checks passed
@mtdvlpr mtdvlpr deleted the feat/docs branch October 15, 2024 12:43
@sircharlo
Copy link
Owner

@mtdvlpr FYI: the changes to the build options were actually breaking builds completely. They built fine, but the installed app would crash on load.
I've included what seemed to be the missing needed modules in dab22f6.
Let me know if I missed something obvious.

@mtdvlpr
Copy link
Contributor Author

mtdvlpr commented Oct 15, 2024

Hmm, weird. Those vue dependencies should be bundled in the ui code. Vue-i18n becomes a vue-i18n_hash.js file, for example. The docs also say that you only have to allow the packages that get imported in the main/preload processes. I'll experiment with it some more. Sorry for not testing it beforehand!

@sircharlo
Copy link
Owner

No worries; I was quite surprised too. I'm not sure why this happened exactly.

@mtdvlpr
Copy link
Contributor Author

mtdvlpr commented Oct 17, 2024

@sircharlo, I found the issue with the electron dependencies. You import errorCatcher in the Electron process and errorCatcher imports @sentry/vue and @sentry/vue imports vue, etc. It should probably be rewritten so that those Electron errors are either captured with Sentry/electron or passed to the UI and captured there.

That would allow for the other UI dependencies to be removed from the Electron output build.

@mtdvlpr
Copy link
Contributor Author

mtdvlpr commented Oct 17, 2024

Check out these docs for combining Sentry/electron with Sentry/vue.

@mtdvlpr
Copy link
Contributor Author

mtdvlpr commented Oct 17, 2024

See #282 for a potential fix

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants