Skip to content

chore: remove toc from documentation page - #5773

Merged
remyleone merged 1 commit into
mainfrom
remove_toc
Jul 2, 2026
Merged

chore: remove toc from documentation page#5773
remyleone merged 1 commit into
mainfrom
remove_toc

Conversation

@remyleone

Copy link
Copy Markdown
Member

Community Note

  • Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request

Relates OR Closes #0000

Release note for CHANGELOG:


Copilot AI review requested due to automatic review settings July 1, 2026 13:58

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/*.md pages.
  • 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 }}; when Cmd.Short is 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.Short is 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 empty release-note block. Please either link the real issue (or remove the placeholder) and set the release note to NONE if 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-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 50.18%. Comparing base (6137003) to head (7bf850c).
✅ All tests successful. No failed tests found.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@remyleone
remyleone added this pull request to the merge queue Jul 2, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to no response for status checks Jul 2, 2026
@remyleone
remyleone added this pull request to the merge queue Jul 2, 2026
Merged via the queue into main with commit 9d31dc2 Jul 2, 2026
124 checks passed
@remyleone
remyleone deleted the remove_toc branch July 2, 2026 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants