Remove redundant Overview headings on TOC-enabled docs pages#721
Merged
IEvangelist merged 3 commits intomainfrom Apr 20, 2026
Merged
Remove redundant Overview headings on TOC-enabled docs pages#721IEvangelist merged 3 commits intomainfrom
IEvangelist merged 3 commits intomainfrom
Conversation
Copilot created this pull request from a session on behalf of
IEvangelist
April 15, 2026 19:52
View session
IEvangelist
approved these changes
Apr 15, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Removes redundant Overview headings from TOC-enabled docs pages and adds enforcement to prevent reintroducing them.
Changes:
- Updated multiple docs pages to remove or rename
## Overviewsections. - Extended doc-writer guidance to forbid
## Overviewon TOC-enabled pages. - Added a docs unit test that fails when TOC-enabled docs include an explicit “Overview” heading.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/frontend/tests/unit/filetree-format.vitest.test.ts | Adds detection + unit-test enforcement for explicit “Overview” headings on TOC-enabled docs pages |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-container-registry/azure-container-registry-host.mdx | Renames Overview heading to a more specific “Key capabilities” section |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-container-registry/azure-container-registry-get-started.mdx | Renames Overview heading to a more specific “Key capabilities” section |
| src/frontend/src/content/docs/deployment/pipelines.mdx | Renames Overview heading to “Pipeline deployment model” |
| src/frontend/src/content/docs/deployment/custom-deployments.mdx | Removes redundant Overview heading so intro content is direct body text |
| src/frontend/src/content/docs/deployment/azure/azure-security-best-practices.mdx | Removes redundant Overview heading so intro content is direct body text |
| .github/skills/doc-writer/SKILL.md | Documents the “no ## Overview on TOC-enabled pages” guidance and suggested alternatives |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Agent-Logs-Url: https://github.com/microsoft/aspire.dev/sessions/f4bf8607-2b13-4b2b-b41e-ae87dc850586 Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
IEvangelist
force-pushed
the
copilot/remove-redundant-overview-headings
branch
from
e6c300f to
e6db30d
Compare
…revent redundancy
JamesNK
approved these changes
Apr 18, 2026
Member
JamesNK
left a comment
JamesNK
left a comment
There was a problem hiding this comment.
Looks good. Clean doc changes, well-engineered test with proper code-fence tracking and frontmatter awareness.
Minor nits (non-blocking):
- The
pipelines.mdxchange (Pipeline model→Pipeline deployment model) isn't removing an Overview heading — PR description is slightly misleading there. - Test file
filetree-format.vitest.test.tsis growing beyond FileTree scope; consider renaming todocs-lint.vitest.test.tsin a follow-up. - Overview heading regex is case-sensitive (
/^\s*##+\s+Overview\s*$/) — unlikely to matter in practice but/iflag would be more defensive.
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.
Summary
Overviewheadings from affected docs pages and keep/rename content where needed.doc-writerskill guidance to explicitly forbid## Overviewon TOC-enabled pages.Overviewheading.Updated articles
src/frontend/src/content/docs/deployment/custom-deployments.mdxsrc/frontend/src/content/docs/deployment/azure/azure-security-best-practices.mdxsrc/frontend/src/content/docs/deployment/pipelines.mdx(Overviewrenamed toPipeline deployment model)src/frontend/src/content/docs/integrations/cloud/azure/azure-container-registry/azure-container-registry-host.mdx(Overviewrenamed toKey capabilities)src/frontend/src/content/docs/integrations/cloud/azure/azure-container-registry/azure-container-registry-get-started.mdx(Overviewrenamed toKey capabilities)Validation
pnpm --dir ./src/frontend run lintpnpm --dir ./src/frontend run test:unit:docspnpm --dir ./src/frontend run build:skip-searchpnpm --dir ./src/frontend run test:unitparallel_validationrun: Code review succeeded; CodeQL timed out per tool warning.