Repository navigation
Add the Security section to the documentation - #88
Merged
Merged
Conversation
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Add Documentation > Security with three pages: - Security policy: `SECURITY.md` of `SpineEventEngine/.github`, fetched when the site is built by the new `remote-markdown` shortcode, so the organization-wide file stays the only source of the text. - Verifying artifacts: how to check the SLSA build provenance of our Maven artifacts with `gh attestation verify`, adapted for consumers from the `config` README. - CVD Policy: moved verbatim from spine.io, which redirects `/cvd-policy/` to it in a follow-up change there. The section comes last in the navigation, after the Validation guides, through a sidenav of its own that `moduleOrder` places after the modules. The preview gets a `date` shortcode for the moved page, and fetched files expire after an hour, so a Hugo cache restored by CI does not keep serving an old `SECURITY.md`. The task document records the decisions and the merge order. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
JuliaEvseeva
approved these changes
Oct 1, 2026
This was referenced Oct 1, 2026
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.
Adds Documentation → Security with three pages, per
.agents/tasks/security-docs-tasks.md(part 1):/docs/security/policy/SECURITY.mdofSpineEventEngine/.github, fetched at build time/docs/security/verifying-artifacts/gh attestation verify/docs/security/cvd-policy//cvd-policy/What changed
remote-markdownshortcode (docs/layouts/_shortcodes/): fetches a Markdown file withresources.GetRemoteand renders it into the page, headings and TOC included. The org-wideSECURITY.mdstays the only source of the policy text; there is no copy to drift.hugo serverit's a warning plus a link to the file, so offline authoring still works.policy.md, not a content adapter: adapter pages have no.File, and the site-commons sidenav finds the current section from.File.Path.--signer-digestpinning. Adapted for consumers from theconfigREADME; maintainer-only details are left out.headline, adescription, samelastmod,has_numbered_headingskept).docs/data/docs/security/sidenav.yml, placed bymoduleOrderindocs/hugo.toml.[caches.getresource] maxAge = '1h'. Hugo's default never expires fetched files, and thecheck-linksworkflow restores the Hugo cache between runs, so it would otherwise keep serving the firstSECURITY.mdforever.dateshortcode for the preview: the moved page uses it. spine.io has its own with the same output, which takes precedence there.Other commits on this branch
Update configandSelect CodeMatters (c) profile: theconfigsubmodule update and the IntelliJ copyright profile switch.Update copyright headers: a repo-wide refresh to the CodeMatters notice (build scripts, samples, one JS file).Add task doc for the Security section: the task document, updated in the last commit with the decisions and the merge order.Merge order: spine.io follow-up
The redirect lives in spine.io, which serves
/cvd-policy/today. Its branchsecurity-section(not pushed yet) does the following:/cvd-policy/→/docs/security/cvd-policy/;Policy:line ofsecurity.txt(also fixes its invalidExpires:timestamp);has_numbered_headingsand fixes the numbered-TOC CSS;workflow_dispatchdeploy trigger, limited tomaster, to publishSECURITY.mdchanges.Merge this PR first. The spine.io PR must then add a bump of the
documentationmodule pin. Without it,/cvd-policy/would redirect to a page that doesn't exist yet.Parts 2 (
.githubSECURITY.mdpointer) and 3 (configREADME) wait until the pages are live.Verification
hugo(production) build of the preview: no errors or warnings, 95 pages.HUGO_MODULE_REPLACEMENTS: pages, sidenav order and expansion, prev/next chain, redirect (with and without the trailing slash), footer, and numbered headings and TOC all checked in a browser.hugo serverwarns and shows the fallback.review-docspass; its findings were applied.Note for reviewers
The Security policy page renders
SECURITY.mdfrommasterofSpineEventEngine/.github, and the site renders raw HTML in Markdown. That branch needs a ruleset, which is listed in the task document's preconditions.🤖 Generated with Claude Code