Update index.adoc#142
Open
Rajakavitha1 wants to merge 1 commit into
Open
Conversation
Removing the in-page TOC there is the TOC in the right side
Author
|
Hi @mmattel This is a partial PR. If you agree that the TOC is redundant then I can commit changes for all the doc files that has two TOCs. |
DeepDiver1975
left a comment
Member
There was a problem hiding this comment.
🤖 Automated review by Claude Code review agent.
Overview
This PR makes a single-line change to modules/ROOT/pages/index.adoc, switching the document-level TOC directive from :toc: right to :toc!:. Per the description and the attached screenshot, the intent is to remove the redundant AsciiDoc in-page table of contents while keeping the theme-provided right-hand "On this page" TOC. The change is minimal, focused, and consistent with that goal.
Documentation accuracy
- The change is purely presentational (TOC rendering) — no prose, xrefs, or links are touched, so there is no risk to documentation content accuracy.
- The remaining
xref:macros in the file are untouched and unaffected.
AsciiDoc syntax correctness
:toc!:is the correct AsciiDoc syntax to unset thetocdocument attribute, which disables the Asciidoctor-generated page TOC. This is valid and does what the description claims.- Worth confirming visually (the attached screenshot already does this): in Antora the right-hand "On this page" TOC is rendered by the UI bundle's
page-tocfeature, which is independent of the Asciidoctor:toc:attribute. So unsetting:toc:removes the duplicate Asciidoctor TOC while the theme TOC remains — matching the stated intent.
Specific suggestions
- Orphaned
:toclevels: 3: With:toc:now unset, the:toclevels: 3attribute on the next line no longer has any effect on the Asciidoctor TOC. It is harmless and keeping it makes a future revert trivial, so removal is optional. If the theme'spage-tochonorstoclevels, leaving it is actually preferable — worth a quick check, but no change required.
Potential issues / risks
- Low risk overall. The only behavioral change is the disappearance of the Asciidoctor right-column TOC; the screenshot confirms the theme TOC still renders.
- If any other pages in this component relied on a consistent
:toc: rightconvention, this page will now differ. That appears intentional here, but if the broader docs set standardizes on:toc: right, consider whether the redundancy should instead be addressed at the UI-bundle level for consistency across all pages. Not blocking for this single-page fix.
LGTM — a clean, well-scoped change. Approving in spirit; only the optional :toclevels: cleanup is worth considering.
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.
Removing the in-page TOC for redundancy. Retaining the Right TOC..