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

[FEAT] Docs & Community #185

Open
2 of 12 tasks
roman-rr opened this issue Jul 8, 2022 · 3 comments
Open
2 of 12 tasks

[FEAT] Docs & Community #185

roman-rr opened this issue Jul 8, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@roman-rr
Copy link
Collaborator

roman-rr commented Jul 8, 2022

For sure, it's good to go with creation of readable and useful docs.
This is technical requirements.

Docs includes

Docs engines

  • StoryBook
  • Docsify
  • Docusaurus
  • Netlify
  • Gatsby
  • HUGO
  • GH pages

Example of good docs

Free hosting with domains

Docs should be served on some host and paired with domain (it is ok to be a 3-level).

  • Github pages
  • Firebase app
  • Vercel
  • Heroku app
  • Netlify

Other conditions

  • Combination should be freemium for this non-commercial project.
  • Good to generate docs from markdown
  • Good to deploy directly from github
  • Good to have some analytics

Welcome all users for any suggestions and opinion ! ✌🏻🚀

@roman-rr roman-rr added the documentation Improvements or additions to documentation label Jul 8, 2022
@roman-rr roman-rr pinned this issue Jul 9, 2022
@bazuka5801
Copy link

For docs: https://vitepress.vuejs.org/

@roman-rr
Copy link
Collaborator Author

@bazuka5801 thank you for the best advice. Docs were created quite fast panejs.com

@bazuka5801
Copy link

bazuka5801 commented Aug 16, 2022

@roman-rr Wonderful documentation!) 👍

@roman-rr roman-rr changed the title [FEAT] Documentations + Hosting + Domain [FEAT] Docs & Community Jul 23, 2023
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

2 participants