Skip to content

Improve request-response page#8228

Open
josbeir wants to merge 5 commits into5.xfrom
5.x-request-response-cleanup
Open

Improve request-response page#8228
josbeir wants to merge 5 commits into5.xfrom
5.x-request-response-cleanup

Conversation

@josbeir
Copy link
Contributor

@josbeir josbeir commented Feb 13, 2026

Updated

  • Reorganized and clarified the document structure in request-response.md, especially request/response section flow and ambiguous subsection names.
  • Improved heading clarity to make navigation easier (for example: “Request Bodies in PUT, PATCH, and DELETE”, “Checking Request Conditions with is()”, “Reading Request Cookies”, “Uploaded Files Quick Reference”, “Reading Cookies from a CookieCollection”).
  • Fixed wording/spelling/grammar issues (including FastCGI phrasing, CLI wording, hash/article usage, and several awkward sentences).
  • Resolved duplicate anchor ambiguity by changing the second cookie anchor to cookie-collection-reading.

VitePress Enhancements

  • Added a code group for JSON vs XML input parsing in the payload section.
  • Added focused/diff-style code annotations where they add value (HTTP method restriction and immutable response mistake/fix).

Copilot AI review requested due to automatic review settings February 13, 2026 19:44
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR improves the request-response documentation page by reorganizing content structure, clarifying headings, fixing spelling/grammar issues, and adding VitePress enhancements for better readability.

Changes:

  • Reorganized section flow and improved heading clarity (e.g., "Request Bodies in PUT, PATCH, and DELETE", "Checking Request Conditions with is()", "Reading Request Cookies")
  • Fixed grammar, spelling, and wording issues throughout (FastCGI phrasing, CLI wording, article usage corrections)
  • Added VitePress code groups for JSON vs XML parsing examples and diff-style annotations for immutable response patterns
  • Resolved duplicate anchor ambiguity by renaming the second cookie anchor to cookie-collection-reading
  • Converted CORS method signatures from individual method tags to a markdown table for better presentation
  • Fixed technical inconsistencies (corrected getClientFileName to getClientFilename, added missing semicolon)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

@LordSimal LordSimal left a comment

Choose a reason for hiding this comment

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

Otherwise this looks good

- Sending the response body.

### Dealing with Content Types
### Setting Content Types
Copy link
Member

Choose a reason for hiding this comment

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

If u are changing the header you might have to add manual a with id for anchor links from other places

Copy link
Contributor Author

Choose a reason for hiding this comment

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

link checker detects these, no errors reported 😎

Copy link
Member

Choose a reason for hiding this comment

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

It only checks within sources. Not core code or other external anchor links

Copy link
Contributor Author

@josbeir josbeir Feb 16, 2026

Choose a reason for hiding this comment

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

hmm.. i (or we) could include a --source-manifest property on the link checker that could be used to parse a file of scanned docblock links (other script) from the current source we include in the repo. That way we are sure no breaking cross referencing happens during CI.

Or another idea? Would be a good addition to keep the docs clean over time (cfr the gazillion PR's followed after the new docs introduction 😃 )

Copy link
Contributor

Choose a reason for hiding this comment

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

Well it can be a separate CI workflow which just runs like once every 1-2 weeks and reports in its own github action way broken links after the fact.

Doing it on a per PR basis can lead to false reports if e.g. headings/links get adjusted in other PR's (on other repos) which are not yet merged.

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.

6 participants

Comments