Skip to content

fix(docs): include navigation breadcrumbs in yml errors#16079

Open
shubhamsinnh wants to merge 2 commits into
fern-api:mainfrom
shubhamsinnh:codex/improve-yml-config-errors
Open

fix(docs): include navigation breadcrumbs in yml errors#16079
shubhamsinnh wants to merge 2 commits into
fern-api:mainfrom
shubhamsinnh:codex/improve-yml-config-errors

Conversation

@shubhamsinnh
Copy link
Copy Markdown

@shubhamsinnh shubhamsinnh commented May 23, 2026

Summary

  • append readable navigation breadcrumbs to docs config schema validation errors
  • apply breadcrumbs to docs.yml, versions.yml, and products.yml validation paths
  • add regression coverage for nested tab/section/page navigation errors

Fixes #10693

Testing

  • D:\first-project\fern\node_modules\.bin\vitest.cmd --run src/__test__/formatNavigationConfigError.test.ts from packages/cli/yaml/docs-validator
  • git diff --check

Notes

  • I also tried npx -p node@22.13.0 -p pnpm@11.0.6 pnpm --filter @fern-api/docs-validator compile, but this sparse checkout fails on unresolved local workspace package type outputs, so it was not a clean validation signal.

@shubhamsinnh shubhamsinnh requested a review from amckinney as a code owner May 23, 2026 00:08
Copy link
Copy Markdown

@claude claude Bot left a comment

Choose a reason for hiding this comment

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

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

@shubhamsinnh shubhamsinnh force-pushed the codex/improve-yml-config-errors branch 2 times, most recently from 067d01a to fa99c7d Compare May 23, 2026 00:12
@shubhamsinnh shubhamsinnh marked this pull request as draft May 23, 2026 00:13
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 3 additional findings.

Open in Devin Review

@shubhamsinnh shubhamsinnh force-pushed the codex/improve-yml-config-errors branch 3 times, most recently from 8c6949e to 41f66bb Compare May 23, 2026 06:14
@shubhamsinnh shubhamsinnh marked this pull request as ready for review May 23, 2026 08:38
Copy link
Copy Markdown
Author

Hi! This PR is ready for review.

Most checks are passing now (compile, biome, lint, test, depcheck, boundaries, version validation, and seed result checks). The remaining test-ete failure appears to be due to Fern auth secrets not being available on this fork PR: the logs show Authentication required / missing FERN_TOKEN.

Please let me know if there is anything else I should update.

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

Devin Review found 1 new potential issue.

View 4 additional findings in Devin Review.

Open in Devin Review

@shubhamsinnh shubhamsinnh force-pushed the codex/improve-yml-config-errors branch 2 times, most recently from 1fecb60 to db29f91 Compare May 25, 2026 02:52
Copy link
Copy Markdown
Author

Hi @amckinney, just wanted to follow up on this when you get a chance.

This is for #10693, where docs config validation errors point to array indexes like $.navigation[5].layout[1], which makes the actual page/section hard to find in larger docs.yml files. I updated the formatter to include readable navigation breadcrumbs, and also addressed the root-level title case Devin flagged.

Would appreciate your review on whether this is the right place and shape for the fix. Happy to adjust if there’s a cleaner pattern you’d prefer.

@shubhamsinnh shubhamsinnh force-pushed the codex/improve-yml-config-errors branch from db29f91 to 7d9fa5c Compare May 25, 2026 03:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Provide page names in .yml configuration errors

1 participant