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.

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

Docs: Refactor /usage/responses into a divided section #3218

Open
JacobCoffee opened this issue Mar 17, 2024 · 2 comments
Open

Docs: Refactor /usage/responses into a divided section #3218

JacobCoffee opened this issue Mar 17, 2024 · 2 comments
Labels
Documentation 📚 This is related to documentation Help Wanted 🆘 This is good for people to work on

Comments

@JacobCoffee
Copy link
Member

JacobCoffee commented Mar 17, 2024

Summary

What

After reading through it this is quite a long page, even with adding to dropdowns.

rfc @litestar-org/maintainers, open to not doing this too - but as someone who just read through it it was tough.

How

Split this section up into something like

responses/
├── index.rst
├── media_types_and_status_codes.rst
├── returning_responses.rst
├── headers_and_cookies.rst
├── special_responses.rst
└── advanced_topics.rst

index.rst contents

  • Introductory section
  • Overview of other sections
  • What is current under the Responses section.

media_types_and_status_codes.rst contents

  • Media Types section
  • Status Codes section

returning_responses.rst contents

  • JSON Responses
  • MessagePack Responses
  • Plaintext responses
  • HTML responses
  • Content Negotiation
  • Redirect Responses

headers_and_cookies.rst contents

  • Setting Response Headers section
  • Setting Headers Dynamically
  • Using Annotated Responses
  • Using the After Request Hook
  • Predefined Headers
  • Cache Control
  • ETag
  • Setting Response Cookies
  • Setting Cookies dynamically
  • Using Annotated Responses
  • Using the After Request Hook

special_responses.rst contents

(idk about this, maybe should just go into the return_responses.rst

  • File Responses
  • Streaming Responses
  • Server Sent Event Responses
  • Template Responses
  • Custom Responses

advanced_topics.rstcontents

  • Background Tasks
  • Executing Multiple Background Tasks
  • Pagination
  • Classic Pagination
  • Offset Pagination
  • Offset Pagination With SQLAlchemy <https://www.sqlalchemy.org/>_
  • Cursor Pagination

Note

While we are open for sponsoring on GitHub Sponsors and
OpenCollective, we also utilize Polar.sh to engage in pledge-based sponsorship.

Check out all issues funded or available for funding on our Polar.sh dashboard

  • If you would like to see an issue prioritized, make a pledge towards it!
  • We receive the pledge once the issue is completed & verified
  • This, along with engagement in the community, helps us know which features are a priority to our users.
Fund with Polar
@JacobCoffee JacobCoffee added Documentation 📚 This is related to documentation Help Wanted 🆘 This is good for people to work on labels Mar 17, 2024
@peterschutt
Copy link
Contributor

I think this would be a nice improvement. Also, DYT we should bring the responses menu item up to the top underneath requests?

@provinzkraut
Copy link
Member

I have already started to work on this (and related things) in #2912.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📚 This is related to documentation Help Wanted 🆘 This is good for people to work on
Projects
Status: Triage
Development

No branches or pull requests

3 participants