search

ci010 / electron-vue-next

A starter template for using vue-next with the electron.
https://ci010.github.io/electron-vue-next/
191 stars 27 forks source link

Improved documentation #35

Open JonasKruckenberg opened 3 years ago

JonasKruckenberg commented 3 years ago

I've had a look at your project, and I have to say it seems very promising. However, I'd really love if you could add more documentation! I think I understand your reasons for the service architecture, but If you could elaborate a bit on Why is it superior? Why do it this way and not any other way? This could also apply to the code itself, maybe add some comments explaining the reason for certain things to exists. What does the dialog API do? How does the shared store work? Again, great work and I can understand your reasons, but as this is a starter-template helping people getting started code-wise but also mentally would be cool 👍

ci010 commented 3 years ago

Currently, we have vitepress document host on github https://ci010.github.io/electron-vue-next/. If you have any suggestion, please let me know! Thanks