Make this repo the source of truth for docs content standards - #3434
Merged
samironsoctopus merged 4 commits intoAug 31, 2026
Conversation
Add the ten documentation content standards to contributing/standards/, migrated verbatim from the octopus-docs-standards Claude plugin skill. The skill and Confluence copies become pointers to these files, so the standards stop drifting across three locations. Reconciled the one difference between the installed skill copies: the stale ~/.claude/skills copy carried an extra "3 years old or newer" guideline in version-notes.md that the committed plugin version (and the shipped marketplace build) had already dropped. Took the current version. Exclude contributing/standards/** from markdownlint and cspell. CI checks every changed .md file repo-wide, and these files intentionally contain fences without a language, a compact-style example table, and a repeated "Version notes" heading demonstrating two format variants. Linting them would mean editing illustrative content rather than fixing defects. README: add a "Documentation standards" section, and repoint the "Docs page layout guidelines" section at the folder instead of the skill and a Confluence search. CONTRIBUTING: put external contributor instructions before Octopus staff instructions, add a line pointing contributors at the standards before they submit, and replace both INSERT-LINK-HERE placeholders with a Confluence search reference so no broken links ship. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The ten standards say what each page type requires, but nothing in the folder said which one to reach for. That guidance existed only in the skill's SKILL.md, so contributors not using Claude Code had an alphabetical file list and no way in. Move the dual-audience parts of SKILL.md here and make this the canonical copy: the content model, choosing a page type from the reader's main job, the guide-versus-tutorial boundary, and the routing table. Named README.md so GitHub renders it as the folder index. Routing and orientation only. It never restates substance from the ten standards, so a stale README can at worst misroute someone to a file that is still correct. The rebuilt skill should point at this file rather than restate any of it, otherwise the routing logic has two copies and we are back to the drift this move was meant to end. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The line described the rebuilt skill's behavior, which isn't true until that rebuild ships. The rest of the section already tells contributors what they need without asserting anything about the skill's internals. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
Pull request environment is available at https://stoctodocspr3434.z22.web.core.windows.net. You can view the ephemeral environment status in Octopus Deploy. This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity. |
borland
approved these changes
Aug 31, 2026
samironsoctopus
deleted the
centralized_standards_and_contribution_guidance
branch
August 31, 2026 06:16
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 this does
Moves the Octopus documentation content standards into this repository and makes it their single source of truth. They currently live in both the
octopus-docs-standardsClaude plugin skill and Confluence, and the copies drift.Task 1 — the standards
Adds ten standards to
contributing/standards/, migrated verbatim from the skill.One difference between the installed skill copies needed reconciling: a stale local copy carried an extra "3 years old or newer" guideline in
version-notes.mdthat the committed plugin version and the shipped marketplace build had already dropped. This takes the current version, so that line is not present here.Also adds
contributing/standards/README.md, which carries the routing and orientation that previously existed only inside the skill'sSKILL.md— the content model, how to pick a page type, the guide-versus-tutorial boundary, and a table of which standards apply to which task. Without it, a contributor not using Claude Code got an alphabetical file list and no way in. It routes and orients only, and never restates substance from the ten standards.Task 2 — top-level README
Adds a short
Documentation standardssection, and repoints the existingDocs page layout guidelinessection at the folder. That section previously sent people to the skill plus a Confluence search, which is now the wrong direction.Task 3 — CONTRIBUTING
INSERT-LINK-HEREplaceholders with a Confluence search reference, so no broken links ship.Lint and spellcheck exclusions
contributing/standards/**is excluded from markdownlint and cspell, following thesrc/pages/docs/api/**precedent already present in both configs.CI checks every changed
.mdfile repo-wide, and the migrated files intentionally contain fences without a language, a compact-style example table, and a repeated "Version notes" heading demonstrating two format variants. Linting them would mean editing illustrative content rather than fixing defects, and would break the verbatim migration.A directory glob was chosen over enumerating the ten filenames deliberately: an enumerated list would need updating in two configs every time a new page-type standard ships, or CI fails on verbatim content.
README.mdin that folder is our own prose rather than migrated content, so it was checked against both markdownlint and cspell out-of-tree and passes cleanly. It is not covered by CI going forward, which is the tradeoff of the directory glob.Sequencing
This needs to merge before the
octopus-docs-standardsskill is repointed at these files, otherwise the skill's references break.Reviewer notes
diff. The only judgment call in them is theversion-notes.mdreconciliation described above.