panes icon indicating copy to clipboard operation
panes copied to clipboard

[FEAT] Docs & Community

Open roman-rr opened this issue 2 years ago • 3 comments

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

Docs includes

  • [x] Detailed descriptions
  • [x] Pages for each live demo with code
  • [x] Promo home page (with buttons and present types e.g. f7, mobile-kitchen, azure presentation styles + get best current demo + https://livewire.laravel.com/) https://dribbble.com/shots/22834806-Website-Design-Concept
  • [x] Code Playground (JSFiddle)
  • [ ] Move playground to docs
  • [ ] Import docs demo example from files (jsfiddle -> local) e.g. tabs code by files
  • [ ] Playground app #210
  • [ ] Simplified basic demo pages by folders (simple style of demos each page, complex examples move to showcases)
  • [ ] Screencasts (+ Pro version)
  • [ ] Pro version playgrounds
  • [ ] Connect vitepress with CMS
  • [ ] Visual creator

Docs engines

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

Example of good docs

  • https://teslamotors.github.io/informed
  • https://ionicframework.com/docs
  • https://swiperjs.com/

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 avatar Jul 08 '22 22:07 roman-rr

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

bazuka5801 avatar Jul 29 '22 09:07 bazuka5801

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

roman-rr avatar Aug 14 '22 17:08 roman-rr

@roman-rr Wonderful documentation!) :+1:

bazuka5801 avatar Aug 16 '22 13:08 bazuka5801