Skip to content

Conversation

Copy link

Copilot AI commented Nov 12, 2025

The documentation lacked a right-side table of contents for in-page navigation, similar to BIDS specification and GitHub's markdown viewer.

Changes

  • Removed toc.integrate feature from MkDocs Material theme configuration
  • This moves the table of contents from the left sidebar to its default right-side position
# mkdocs.yml
theme:
  features: []  # Previously: - toc.integrate
previews ## Result

Before: TOC integrated into left navigation sidebar
Before

After: TOC displayed on right side for in-page navigation
After
Example page

Original prompt

This section details on the original issue you should resolve

<issue_title>Adopt feature for section context menu on the right</issue_title>
<issue_description>see e.g. how bids has it also with mkdocs material: https://bids-specification.readthedocs.io/en/stable/modality-specific-files/magnetic-resonance-imaging-data.html and now even github has it for viewing .md files:
https://github.com/bids-dandisets/dashboard/blob/main/README.md#bids-dandisets-dashboard

Image</issue_description>

<agent_instructions>adjust configuration for mkdocs do get that context menu on the right</agent_instructions>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Add feature for section context menu on the right Enable right-side table of contents in MkDocs Nov 12, 2025
Copilot AI requested a review from yarikoptic November 12, 2025 17:12
Copilot finished work on behalf of yarikoptic November 12, 2025 17:12
accent: "light blue"
features:
- toc.integrate
features: []
Copy link
Member

Choose a reason for hiding this comment

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

@copilot could you check git history on when we added that toc.integrate here -- may be there is description on why we decided to go that way?

Copy link
Author

Choose a reason for hiding this comment

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

The toc.integrate feature was added in commit 73ad53b by @yarikoptic on July 27, 2022, and merged via PR #73 on August 30, 2022.

The reasoning from the commit message was:

"Instead of having a separate TOC on the right, it would just expand already present navigation on the left, IMHO making 1. a better use of screen real estate, 2. no longer requiring user to jump with mouse from left to right to navigate"

However, the current issue #216 requests the opposite behavior to match modern documentation sites like BIDS specification and GitHub's markdown viewer, which display the TOC on the right side. The current PR removes toc.integrate to enable that right-side TOC display.

Copy link
Member

Choose a reason for hiding this comment

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

WDYT @kabilar @satra ? boils down to

  • consistency with other portals vs more horizontal real estate

Copy link
Member

Choose a reason for hiding this comment

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

Hi @yarikoptic, I prefer a single, unified navigation which is easier for me to navigate. And provides more space for content.

Copilot AI requested a review from yarikoptic November 12, 2025 17:23
Copilot finished work on behalf of yarikoptic November 12, 2025 17:23
@yarikoptic yarikoptic marked this pull request as ready for review November 12, 2025 17:27
@CodyCBakerPhD
Copy link
Contributor

Is there a dev branch deployment of docs to try out what this feels like?

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.

Adopt feature for section context menu on the right

4 participants