Skip to content

/ warthog

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

Jump to bottom

Documentation site #322

Open
goldcaddy77 opened this issue Mar 31, 2020 · 5 comments
Open

Documentation site #322

goldcaddy77 opened this issue Mar 31, 2020 · 5 comments
Labels
help wanted

Comments

@goldcaddy77
Copy link
Owner

@goldcaddy77 goldcaddy77 commented Mar 31, 2020 •
edited

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:
@goldcaddy77

Loading…

Owner Author

@goldcaddy77 goldcaddy77 commented Apr 5, 2020 •
edited

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: #343
  • Contributing
    • Testing: test, test:watch and test -u (passes args through)
  • Add relay pattern: #408
@Quadrisheriff

Loading…

@Quadrisheriff Quadrisheriff commented May 23, 2020

is it compulsory to use docz?
@goldcaddy77

Loading…

Owner Author

@goldcaddy77 goldcaddy77 commented May 23, 2020

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

Loading…

@Quadrisheriff Quadrisheriff commented May 23, 2020

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

Loading…

Owner Author

@goldcaddy77 goldcaddy77 commented May 24, 2020 •
edited

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/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
@goldcaddy77 @Quadrisheriff
You can’t perform that action at this time.