docs: route readers to the CSP mechanism and the api README (P-routing) - #364
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Improves repo documentation discoverability by routing fork owners to the correct CSP/security documentation and making the API routes documentation easier to find from the app docs.
Changes:
- Adds
SECURITY.mdandapp/api/README.mdentries to the top-level Documentation table inREADME.md. - Adds an explicit link from
app/README.mdto the API routes reference. - Updates
AGENTS.mdto point readers to the CSP composition mechanism andSECURITY.md.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Expands the documentation index to include Security and API Routes docs. |
| app/README.md | Links readers directly to the API routes documentation. |
| AGENTS.md | Clarifies where CSP/security header composition is defined and documented. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| deliberate decision to ship it to `/studio` too. App-flavored concerns | ||
| (providers, metadata, analytics) belong in `app/(site)/layout.tsx`. | ||
|
|
||
| See [app/api/README.md](api/README.md) for the API surface (endpoints, webhook setup). |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A fork owner asking how to change the CSP could not route there; README gains Security and API Routes doc-table rows, AGENTS.md's proxy note names cspSources/PROJECT_CSP_EXTRA_SOURCES, app/README links the orphaned api README.
Process-audit docs finding. Test plan: oxfmt clean on touched files, link targets verified, full check green on the branch set.