Skip to content

Refine TOC validation logic and error messaging. #827

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 24, 2025

Conversation

Mpdreamz
Copy link
Member

@Mpdreamz Mpdreamz commented Mar 24, 2025

Improve handling of TOC nesting rules by adding checks for valid file paths and better accommodating development and narrative docs. Update error messages for clarity and adjust depth validation to reflect maximum allowed levels.

(cherry picked from commit 3e61bec)

Relates: #780 (comment)

This ensures that if a toc: section links to other toc sections

  • it may at most link to one index.md at the root.
  • it must link to one index.md for nested toc.yml files.

Improve handling of TOC nesting rules by adding checks for valid file paths and better accommodating development and narrative docs. Update error messages for clarity and adjust depth validation to reflect maximum allowed levels.

(cherry picked from commit 3e61bec)
@Mpdreamz Mpdreamz requested a review from a team as a code owner March 24, 2025 17:21
@Mpdreamz Mpdreamz added the fix label Mar 24, 2025
@Mpdreamz Mpdreamz self-assigned this Mar 24, 2025
@Mpdreamz Mpdreamz merged commit 2de46fb into main Mar 24, 2025
11 checks passed
@Mpdreamz Mpdreamz deleted the fix/toc-item-checks-2 branch March 24, 2025 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants