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.

Sign up for GitHub

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

Jump to bottom

Vuestic admin documentation #978

Open

asvae opened this issue Nov 21, 2023 · 0 comments

Labels

d3: medium v3: wish to have

Contributor

asvae commented Nov 21, 2023 •

edited

Right now vuestic admin have very limited documentation:

Wiki - incredibly outdated
Github readme - actual, but only focuses on few things
Occasional comments in docs
Occasional stories for components

I believe we're missing significant items for docs, that are also not that hard to implement. Here's some items I can think of:

project structure
tailwind documentation
conventions used
linter setup used
How we can use vuestic-admin for existing project? #975
testing setup
storybook setup
onboarding info

The simplest way to introduce that kind of documentation (I think) would be to copy existing documentation from vuestic-ui.

asvae added d3: medium v3: wish to have labels

asvae mentioned this issue

Close wiki - it's still getting indexed #977

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment