warthog icon indicating copy to clipboard operation
warthog copied to clipboard

Published 20 hours ago • verified publisher icon goldcaddy77

Documentation site

Open goldcaddy77 opened this issue 4 years ago • 5 comments

Need a documentation site - the README is large and still falling behind the existing functionality.

Requirements:

  • Must be generated from md or mdx
  • Hosted in this repo

Look at docz:

  • https://github.com/doczjs/docz
  • https://github.com/rakannimer/create-docz-app#readme
  • Example: http://welcome-ui.com/
  • More examples: https://github.com/doczjs/docz/tree/master/examples

goldcaddy77 avatar Mar 31 '20 03:03 goldcaddy77

Add to docs:

  • Everything from README
  • Full listing of decorators
  • Full listing of options available in decorator
  • Examples of decorator usage (ex. password being writeonly)
  • When would you use IdField vs StringField
  • Limitations around using transactions
  • Web server best practices - see #333 and https://shuheikagawa.com/blog/2019/04/25/keep-alive-timeout/
  • DB
    • Composite indicies: https://github.com/goldcaddy77/warthog/issues/343
  • Contributing
    • Testing: test, test:watch and test -u (passes args through)
  • Add relay pattern: https://github.com/goldcaddy77/warthog/pull/408

goldcaddy77 avatar Apr 05 '20 18:04 goldcaddy77

is it compulsory to use docz?

Quadrisheriff avatar May 23 '20 21:05 Quadrisheriff

It’s not, but I’m pretty far along. What would you recommend?

goldcaddy77 avatar May 23 '20 21:05 goldcaddy77

Nothing actually, I want to take on the project but i have never worked with docz before. Guess i'll just start learning as quick as i can.

Quadrisheriff avatar May 23 '20 22:05 Quadrisheriff

Oh you don’t need to know docz. It just generates HTML that I’ll host on https://warthog.dev . You can see the very rough version here: https://gifted-panini-c878aa.netlify.app/

goldcaddy77 avatar May 24 '20 00:05 goldcaddy77