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

Documentation for backend setup #77

Open
robchendev opened this issue Feb 11, 2023 · 1 comment
Open

Documentation for backend setup #77

robchendev opened this issue Feb 11, 2023 · 1 comment
Labels
Documentation Improvements or additions to documentation

Comments

@robchendev
Copy link

robchendev commented Feb 11, 2023

We'll need documentation to be setup and ready to be added/reviewed because development is beginning to get hairy.

We'll leave the front-end documentation with storybook and focus on making documentation for backend API and logic need-to-know. There are several good documentation software to choose from:

https://www.dokuwiki.org/dokuwiki
https://www.bookstackapp.com/
https://docusaurus.io/

@robchendev robchendev added the Documentation Improvements or additions to documentation label Feb 11, 2023
@robchendev
Copy link
Author

Docusaurus will be a separate repo: https://github.com/VikeLabs/documentation

Let's structure it in a way assuming that it will contain the documentation for other projects as well, so all vikelab project related documentation can be accessed at docs.vikelabs.ca

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
Projects
None yet
Development

No branches or pull requests

1 participant