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

Identify the .mdx files affected in certain build errors #5809

Open
ember-stevens opened this issue Jan 30, 2025 · 0 comments
Open

Identify the .mdx files affected in certain build errors #5809

ember-stevens opened this issue Jan 30, 2025 · 0 comments
Labels
feature Requests for new features. product/docs Fern Docs which builds and hosts a developer documentation site

Comments

@ember-stevens
Copy link

Feature Description

Some build errors do not identify the .mdx files affected, and instead identify only line numbers. For example, I recently tried to build locally and received this error:

[docs]:Failed to read docs configuration. Rendering blank page.
[docs]:Expected a closing tag for `<Callout>` (22:1-22:127) before the end of `paragraph`

This message provides a line and column number, but no file identifier.

Use Case

Identifying the file names in error messages will greatly reduce the amount of troubleshooting needed to fix the error. In this case, I had opened a large PR with many callout changes so it was difficult to find the problem.

Proposed Experience (Optional)

Optionally, the error message would appear something like this:

[docs]:Failed to read docs configuration. Rendering blank page.
[docs]:Expected a closing tag for `<Callout>` (22:1-22:127) before the end of `paragraph` in home/topics/example.mdx`

Alternatives Considered (Optional)

No response

@ember-stevens ember-stevens added feature Requests for new features. product/docs Fern Docs which builds and hosts a developer documentation site labels Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Requests for new features. product/docs Fern Docs which builds and hosts a developer documentation site
Development

No branches or pull requests

1 participant