(fix): docs preview server is fault tolerant to invalid docs.yml files
#3648
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dsinghvi
deleted the
dsinghvi/preview-server-is-fault-tolerant-to-validation-errors
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When the docs preview server is run with
fern dev docsand thedocs.ymlbecomes invalid, the preview server would exit 1 without a clear message of what went wrong.With this change:
project->DocsDefinitiondocs.ymlis validated and the user receives logs about potential validation errorsB/c of the improved error handling, there will always be a site that is rendered on
localhost:3000