Skip to content

Update index.adoc#142

Open
Rajakavitha1 wants to merge 1 commit into
owncloud:masterfrom
Rajakavitha1:patch-1
Open

Update index.adoc#142
Rajakavitha1 wants to merge 1 commit into
owncloud:masterfrom
Rajakavitha1:patch-1

Conversation

@Rajakavitha1

@Rajakavitha1 Rajakavitha1 commented Dec 22, 2025

Copy link
Copy Markdown

Removing the in-page TOC for redundancy. Retaining the Right TOC..

Screenshot 2025-12-22 at 2 56 40 PM

Removing the in-page TOC there is the TOC in the right side
@mmattel mmattel self-requested a review December 22, 2025 09:31
@Rajakavitha1

Copy link
Copy Markdown
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 DeepDiver1975 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🤖 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 the toc document 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-toc feature, 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: 3 attribute 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's page-toc honors toclevels, 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: right convention, 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.

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.

2 participants