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.

Sign up for GitHub

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

ReadTheDocs Documentation #5

Open
1 of 15 tasks
TheClockTwister opened this issue Mar 12, 2021 · 0 comments
Open
1 of 15 tasks

ReadTheDocs Documentation #5

TheClockTwister opened this issue Mar 12, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
Version 2.0

Comments

@TheClockTwister
Copy link
Owner

TheClockTwister commented Mar 12, 2021 •
edited

Documentation at aeros.readthedocs.io

What needs to be done:

  • Getting Started section
  • MANY examples
  • Auto-doc strings for methods and classes
  • type hints for methods and classes
  • Common problems / mistakes / fixes
  • Suggestions for development and deployment
  • Benchmark section

Also, document all features:

  • Detailed (and colored) logging
  • Auto async converter
  • The default Flask/Quart features
  • Execution parameter tweaking
  • EasyRequest
  • Server-side caching
  • Client-side caching
  • Compression
@TheClockTwister TheClockTwister added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 12, 2021
@TheClockTwister TheClockTwister added this to the Version 2.0 milestone Mar 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
Version 2.0
Development

No branches or pull requests
1 participant
@TheClockTwister