Uh oh!
There was an error while loading. Please reload this page.
fix(structure): move standards/ into docs/standards/ — all docs under /docs - #7
Conversation
… /docs No documentation should live outside /docs in the platform repo. Moving the 11 canonical standards .mdx files into docs/standards/ so they appear in the MkDocs nav and are co-located with the how-to pages about the standards system (consuming, contributing, propagation, authoring-guide). Changes: - Move standards/*.mdx → docs/standards/*.md (rename extension for MkDocs) - Convert Docusaurus :::admonition syntax → MkDocs !!! admonition syntax - Delete root-level standards/ entirely - Add all 11 content files to mkdocs.yml nav under Standards section - Update templates/_common/STANDARDS.md stub URL (docs/standards/) - Update ADR-0002 path references - Update sync workflow in azurelocal.github.io: source path + copies .md as .mdx so Docusaurus site extension stays consistent Closes#6 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR consolidates canonical AzureLocal standards content under docs/ (to align with the repo’s MkDocs structure), updates navigation and references, and removes the deprecated root-level standards/ directory.
Changes:
- Moved canonical standards pages from
/standards/*.mdxto/docs/standards/*.mdand updated some admonition syntax for MkDocs. - Updated
mkdocs.ymlnavigation to include all standards content under the Standards section. - Updated references in the
STANDARDS.mdtemplate stub and ADR-0002 to the new canonical location; removed the rootstandards/docs.
Reviewed changes
Copilot reviewed 10 out of 17 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
templates/_common/STANDARDS.md | Updates canonical source link to the new docs/standards location. |
mkdocs.yml | Adds the moved standards pages into MkDocs nav so they render on the site. |
docs/standards/index.md | Replaces the stub with a standards landing page (ported from the old MDX index). |
docs/standards/automation.md | MkDocs-friendly admonition conversion + content now lives under docs/standards/. |
docs/standards/documentation.md | Adds the documentation standard page under the consolidated location. |
docs/standards/examples.md | Converts admonition syntax for MkDocs. |
docs/standards/infrastructure.md | Adds infrastructure standards page under the consolidated location. |
docs/standards/naming.md | Adds naming conventions page under the consolidated location. |
docs/standards/new-repo-setup.md | Adds new-repo setup runbook under the consolidated location. |
docs/standards/repository-management.md | Adds repository management standard under the consolidated location. |
docs/standards/scripting.md | Adds scripting standards page under the consolidated location. |
docs/standards/solutions.md | Converts admonition syntax for MkDocs. |
docs/standards/testing.md | Converts admonition syntax for MkDocs. |
docs/standards/variables.md | Adds variable management standard under the consolidated location. |
decisions/0002-standards-single-source.md | Updates ADR-0002 canonical path and distribution model details to match new layout. |
standards/README.md | Removes obsolete root-level standards README (root standards/ deprecation). |
standards/index.mdx | Removes obsolete root-level Docusaurus MDX index. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Canonical standards docs live **only** in `AzureLocal/platform/docs/standards/`. No other repo keeps a local copy. | ||
| Distribution model: | ||
| 1. **Community docs site** (`azurelocal.github.io`) continues to render standards for humans. It pulls `platform/standards/*.mdx` via a scheduled GitHub Actions workflow (scheduled on platform release tags). The site renders, the platform repo authors. | ||
| 1. **Community docs site** (`azurelocal.github.io`) continues to render standards for humans. It pulls `platform/docs/standards/*.md` via a scheduled GitHub Actions workflow and publishes them as `.mdx` in the site's `standards/` folder. The site renders, the platform repo authors. | ||
| 2. **Product repos** carry a `STANDARDS.md` stub (~6 lines) at repo root that links to [`https://github.com/AzureLocal/platform/tree/main/standards`](https://github.com/AzureLocal/platform/tree/main/standards). No files copied. | ||
| 2. **Product repos** carry a `STANDARDS.md` stub (~6 lines) at repo root that links to [`https://github.com/AzureLocal/platform/tree/main/docs/standards`](https://github.com/AzureLocal/platform/tree/main/docs/standards). No files copied. |
There was a problem hiding this comment.
Now that the canonical standards location is platform/docs/standards, there are still in-repo docs that link to the old platform/standards path (e.g. docs/getting-started/why-platform-exists.md, docs/getting-started/glossary.md, docs/onboarding/adopt-from-existing-repo.md). Please update those references to avoid leaving stale links after this ADR change.
Uh oh!
There was an error while loading. Please reload this page.
Problem
After Phase 1, the platform repo had docs in two places:
/standards/(the canonical content files) and/docs/standards/(the how-to pages about the system). Nothing should live outside/docs/in a dedicated platform repo.Fixes#6.
Changes
standards/*.mdxfiles →docs/standards/*.md(renamed extension for MkDocs):::admonitionsyntax → MkDocs!!! admonitionsyntax in 4 filesstandards/at root entirelymkdocs.ymlnav under the Standards section — they now render atazurelocal.cloud/platform/standards/templates/_common/STANDARDS.mdstub link to new pathazurelocal.github.iosync workflow: source changed todocs/standards/*.md, copies as.mdxfor Docusaurus consistencyProduct repo
STANDARDS.mdstubs are updated in follow-up commits (one per repo, pushed directly — they're 1-line URL fixes).Test plan
!!! warningand!!! infoadmonitions render correctly in MkDocs Materialstandards/path🤖 Generated with Claude Code