Update Security Findings schema reference page#37807
Open
alliejones wants to merge 2 commits into
Open
Conversation
Contributor
Preview links (active after the
|
This comment has been minimized.
This comment has been minimized.
Contributor
Author
|
/review |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🤖 Automated review by Claude. AI-generated; verify before acting.
This PR cleanly moves the long examples and schema reference content into generated include files. One real issue: a stray trailing space was introduced inside the backticks for origin in the Tags section. A couple of smaller suggestions on the new "Linking to findings" section.
Reviewed 1d527aa457513c7d12f2300fecd176e5794f7c40 — workflow run
volnt
approved these changes
Jun 29, 2026
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
alliejones
force-pushed
the
allie.jones/move-generated-docs-to-partials
branch
from
7b5579b to
72325f1
Compare
Contributor
|
Created DOCS-14972 for docs review. |
Contributor
Author
|
@maycmlee Sorry for omitting this context previously, but there is no new content in this PR, just a reorganization of existing content into separate files. I'll add this to the overall description as well. |
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
3 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.
What does this PR do? What is the motivation?
Some parts of our findings docs are auto-generated by an internal tool, but some parts are higher-level information that is edited manually. This splits our documentation into generated partials and a top level markdown doc with the more general content. This makes the top level doc much shorter and easier to understand as well.
There is no new content added in this PR, it only restructures existing content. (Except for the small fixes suggested by the AI review, which I accepted.)
Motivated by #37240 where I added documentation to this repo directly but it was overwritten by the autogenerated content.
Merge readiness
AI assistance
Used AI coding assistance to restructure the markdown file, no AI-written prose
Additional notes
The companion PR for updating the generation code is #323671; they should both be merged around the same time to keep things in sync but there is no hard requirement on the ordering (updating the generated docs is a manually triggered process).