Documentation site

[goldcaddy77]

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]

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 chore(server): Set keep-alive and headers timeouts on server start #333 and https://shuheikagawa.com/blog/2019/04/25/keep-alive-timeout/
• DB
  • Composite indicies: Composite unique index on relationship entity #343
• Contributing
  • Testing: test, test:watch and test -u (passes args through)
• Add relay pattern: feat(relay): update connection pattern to conform to relay #408

[Quadrisheriff]

is it compulsory to use docz?

[goldcaddy77]

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

[Quadrisheriff]

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.

[goldcaddy77]

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/