docs(vulnerability-disclosure): normalize structure and wording - #567
Merged
Conversation
Add Key Takeaways, contributors, page map, related frameworks, and Further reading. Editorial cleanup only; no new security controls.
Deploying frameworks with
|
| Latest commit: |
55942b1
|
| Status: | ⚡️ Build in progress... |
Match develop authorship exactly. Clear wrote/reviewed/fact-checked arrays where normalization invented authors on pages that had none. Do not attribute chrome-only edits as content authorship.
Rewrite non-stub frontmatter descriptions into the acceptable length band (preferred 140–160). Stub pages exempt. No body or credit changes.
Rename Further Reading H2s to the exact title the updated #561 validator accepts; sentence-case a few common section headings.
…uation Replace an awkward triage bullet on the overview and terminate the bug bounties description with a period for consistent frontmatter style.
frameworks-volunteer
approved these changes
Jul 27, 2026
frameworks-volunteer
left a comment
frameworks-volunteer
left a comment
Collaborator
There was a problem hiding this comment.
Model: z-ai/glm-5.2 Reasoning: medium Provider: openrouter
Approve. Clean editorial/structural normalization of the vulnerability-disclosure framework.
Security: no concerns. Docs-only changes, no secrets, no injection vectors, no unsafe patterns. Vendor claims (Hackenproof E2E encryption) correctly hedged with "as described by the vendor."
QA:
- cspell clean, markdownlint clean on all 3 touched files
- All internal links resolve to existing pages (safe-harbor, external-security-reviews, incident-management, secure-software-development, security-testing, security-contact, bug-bounties)
- External links relevant and valid (ISO 29147, FIRST PSIRT, security.txt, RFC 9116, GitHub docs, vendor sites, disclose.io)
- Frontmatter matches convention from encryption normalization (empty contributor arrays, 140-160 char descriptions)
- Key Takeaways all under 40 words, canonical form with 🔑 emoji
- No leftover debug content, TODOs, or placeholder text
- Commit "docs: drop invented contributor credits" correctly removed any spurious attributions
No blocking issues. Ready to merge.
mattaereal
commented
Jul 27, 2026
Collaborator
|
Model: Re-checked the two commits pushed after the prior approval ( Changes since last review — both are heading casing fixes only:
No substantive changes. Headings now match the sentence-casing convention referenced in commit |
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
2 participants
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.
Scope
Normalize the Vulnerability Disclosure framework (
docs/pages/vulnerability-disclosure/) to the content model.Why
Structure as of
developlacked Key Takeaways, contributors frontmatter, overview page map, Related frameworks, and Further reading. Prose needed light editorial cleanup (clarity only).Content model applied
Changes
overview.mdx: KT, basics, page map, related frameworks, further reading, contributorssecurity-contact.mdx: KT, clearer sectioning, further reading, contributorsbug-bounties.mdx: KT, platform notes softened as market-time (no new controls), further reading, contributorsSubstantive security changes
None. Editorial/structural only. Existing platform names and practices retained; vendor claims labeled as vendor-described where relevant.
Intentionally unchanged
dev: true)index.mdxValidation
docs:build(not re-run this PR; structural MDX only)Dependencies
Depends on content standards in #561 (unmerged). Apply #561 rules by reference; this PR does not copy standards files.
Reviewer focus