Skip to content
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

fix(cli): improve docs error messages around references to missing mdx files #5771

Merged
merged 5 commits into from
Jan 27, 2025

Conversation

dsinghvi
Copy link
Member

@dsinghvi dsinghvi commented Jan 27, 2025

Description

Before:
Uploading image.png…

After:
Uploading Screenshot 2025-01-27 at 12.35.34 PM.png…

Changes Made

  • Use fdr-sdk to remove false positives on missing markdown files when resolving slugs
  • Adds a fern check rule that is keyed based on each mdx file and prints which file is referenced and not included in docs.yml

Testing

  • Unit tests added/updated
  • Manual testing completed

@dsinghvi dsinghvi changed the title fix: improve docs error messages around references to missing mdx files fix(cli): improve docs error messages around references to missing mdx files Jan 27, 2025
Copy link

github-actions bot commented Jan 27, 2025

@dsinghvi dsinghvi merged commit 25c6751 into main Jan 27, 2025
51 of 52 checks passed
@dsinghvi dsinghvi deleted the dsinghvi/fern-check-markdown-file-references branch January 27, 2025 17:42
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.

1 participant