Conversation
There was a problem hiding this comment.
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
methodtags to a markdown table for better presentation - Fixed technical inconsistencies (corrected
getClientFileNametogetClientFilename, added missing semicolon)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
LordSimal
left a comment
There was a problem hiding this comment.
Otherwise this looks good
| - Sending the response body. | ||
|
|
||
| ### Dealing with Content Types | ||
| ### Setting Content Types |
There was a problem hiding this comment.
If u are changing the header you might have to add manual a with id for anchor links from other places
There was a problem hiding this comment.
link checker detects these, no errors reported 😎
There was a problem hiding this comment.
It only checks within sources. Not core code or other external anchor links
There was a problem hiding this comment.
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 😃 )
There was a problem hiding this comment.
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.
Updated
cookie-collection-reading.VitePress Enhancements