chore: remove toc from documentation page - #5773
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot couldn't run its full agentic review because no GitHub Actions runner was available. Make sure your repository has a runner available to run Copilot's review, or add a copilot-setup-steps.yml file specifying one with the runs-on attribute. See the docs for more details.
Removes the autogenerated table of contents (TOC) from CLI command documentation pages to simplify the docs layout.
Changes:
- Updated the doc generation template to stop emitting the per-namespace TOC block.
- Removed existing TOC blocks from generated
docs/commands/*.mdpages. - Cleaned up trailing blank lines left by the previous TOC rendering in some pages.
Reviewed changes
Copilot reviewed 58 out of 58 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| internal/docgen/main.md.tmpl | Removes the TOC generation block from the doc template. |
| docs/commands/account.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/alias.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/apple-silicon.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/audit-trail.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/autocomplete.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/baremetal.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/billing.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/block.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/cockpit.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/config.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/container.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/datalab.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/datawarehouse.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/dns.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/domain.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/edge-services.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/environmental-footprint.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/feedback.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/file.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/fip.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/function.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/help.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/iam.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/inference.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/info.md | Removes trailing empty lines (previously around the TOC area). |
| docs/commands/init.md | Removes trailing empty lines (previously around the TOC area). |
| docs/commands/instance.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/interlink.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/iot.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/ipam.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/jobs.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/k8s.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/kafka.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/keymanager.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/lb.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/login.md | Removes trailing empty lines (previously around the TOC area). |
| docs/commands/marketplace.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/mcp.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/mnq.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/mongodb.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/object.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/partner.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/product-catalog.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/rdb.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/redis.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/registry.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/s2s-vpn.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/sdb-sql.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/search.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/searchdb.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/secret.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/shell.md | Removes trailing empty lines (previously around the TOC area). |
| docs/commands/tem.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/version.md | Removes trailing empty lines (previously around the TOC area). |
| docs/commands/vpc-gw.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/vpc.md | Removes autogenerated TOC section from the rendered docs page. |
| docs/commands/webhosting.md | Removes autogenerated TOC section from the rendered docs page. |
Comments suppressed due to low confidence (4)
internal/docgen/main.md.tmpl:1
- The template always renders
## {{ $resource.Cmd.Short }}; whenCmd.Shortis empty (seen in generated docs as##), this produces invalid/ugly markdown headings. Consider guarding on a non-empty title (e.g., skip resources where$resource.Cmd.Shortis empty, or fall back to$resourceName) so docgen never emits empty section headers.
docs/commands/searchdb.md:1 - This page starts with an empty level-2 heading (
##), which breaks structure and creates a blank anchor in rendered docs. This likely comes from docgen emitting a resource with an empty title; after addressing that in the generator/template, please regenerate this page so the heading is either removed or has a meaningful title.
docs/commands/jobs.md:1 - This file also contains an empty
##header and an effectively empty section immediately after it. Once the doc generator avoids emitting empty resource titles, regenerate this doc so it no longer contains empty headings/sections.
internal/docgen/main.md.tmpl:1 - The PR description still contains placeholders (
Relates OR Closes #0000) and an emptyrelease-noteblock. Please either link the real issue (or remove the placeholder) and set the release note toNONEif this change is not user-facing, to match the repository’s PR template expectations.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5773 +/- ##
=======================================
Coverage 50.18% 50.18%
=======================================
Files 345 345
Lines 79396 79396
=======================================
Hits 39846 39846
Misses 38048 38048
Partials 1502 1502 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Community Note
Relates OR Closes #0000
Release note for CHANGELOG: