docs: move platform security reference into Contributing docs#613
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR relocates the platform “security internals” documentation out of the repository root (where GitHub interprets SECURITY.md as a disclosure policy) and into the Contributing documentation section, so the repo can inherit the organization-wide security policy while still keeping contributor-focused implementation notes.
Changes:
- Adds a new Contributing doc page:
docs/contributing/security.md(Wrappers platform security internals). - Registers the new page in the MkDocs navigation under Contributing → Security Internals.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
mkdocs.yaml |
Adds the new “Security Internals” page to the Contributing navigation. |
docs/contributing/security.md |
Introduces a contributor-focused security internals reference (WASM checksums, error sanitization, response limits, etc.). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
What
Moves the root
SECURITY.mdtodocs/contributing/security.mdand adds it to the MkDocs nav under Contributing → Security Internals.References supabase/.github#20
Why
The root
SECURITY.mdis not a vulnerability-disclosure policy. It's contributor/implementation documentation (WASM checksum verification, credential masking, response size limits) that cites source files likewasm_fdw.rsandutils.rsand shows how to use internal utilities such assanitize_error_message.Because GitHub treats any root
SECURITY.mdas the repo's "Security policy", this file was overriding the organization-wide disclosure policy maintained insupabase/.github. Moving it:The existing user-facing
docs/guides/security.md(FDW usage, RLS,security definer) is unaffected; this is a separate, contributor-focused document.Note
Takes effect alongside supabase/.github#20.