Skip to content

docs: split responses usage guide into sub-pages#4919

Closed
Brohammad wants to merge 6 commits into
litestar-org:mainfrom
Brohammad:docs/split-responses-section
Closed

docs: split responses usage guide into sub-pages#4919
Brohammad wants to merge 6 commits into
litestar-org:mainfrom
Brohammad:docs/split-responses-section

Conversation

@Brohammad

@Brohammad Brohammad commented Jul 13, 2026

Copy link
Copy Markdown

Summary

  • Split the monolithic docs/usage/responses.rst page into a docs/usage/responses/ section with focused sub-pages.
  • Moved the Responses entry directly under Requests in the Usage sidebar.
  • Updated cross-references across onboarding, applications, and release notes docs.

Closes #3218

Test plan

  • uv run --isolated sphinx-build -M html docs docs/_build/ -j auto -W
  • Verify Responses sub-pages render correctly in the docs sidebar
  • Spot-check updated :ref: links from onboarding and applications pages

Documentation preview: https://litestar-org.github.io/litestar-docs-preview/4919


📚 Documentation preview 📚: https://litestar-org.github.io/litestar-docs-preview/4919

Closes litestar-org#3218 by reorganizing the monolithic responses page into a
focused multi-page section and moving it under Requests in the sidebar.

Co-authored-by: Cursor <cursoragent@cursor.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ab0625ae09

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/usage/index.rst
Brohammad and others added 2 commits July 13, 2026 19:47
Add an orphan redirect stub at usage/responses so existing bookmarks
and external links to /usage/responses.html keep working.

Co-authored-by: Cursor <cursoragent@cursor.com>
Drop the non-functional meta refresh tag and keep an orphan stub page
at usage/responses so the old URL still resolves.

Co-authored-by: Cursor <cursoragent@cursor.com>
@Brohammad

Copy link
Copy Markdown
Author

Ready for review — docs-only change for #3218. CI is green.

@Brohammad

Copy link
Copy Markdown
Author

Addressed in f5e0d2e — added an orphan stub at docs/usage/responses.rst so the legacy /usage/responses.html URL still resolves and links to the new section.

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Chef's kiss.

Reviewed commit: f5e0d2e15f

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@codecov

codecov Bot commented Jul 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.29%. Comparing base (bd18fd4) to head (b828252).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4919   +/-   ##
=======================================
  Coverage   67.29%   67.29%           
=======================================
  Files         293      293           
  Lines       15228    15228           
  Branches     1728     1728           
=======================================
  Hits        10248    10248           
  Misses       4833     4833           
  Partials      147      147           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@provinzkraut

Copy link
Copy Markdown
Member

Closing per our AI policy. @Brohammad please do not submit any more fully AI generated PRs, especially if they're large in scope. Further violations of our AI policy will lead to your account being blocked from this organisation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Refactor /usage/responses into a divided section

3 participants