docs: Improve preview via API documentation #1948
Merged
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
bprusinowski
force-pushed
the
docs/better-preview-via-api-docs
branch
from
ee0c8c9 to
5c0f681
Compare
noahonyejese
approved these changes
Jan 8, 2025
...to avoid module import problems when generating JSON Schemas off the config-types file.
bprusinowski
force-pushed
the
docs/better-preview-via-api-docs
branch
from
572f8aa to
217194a
Compare
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.
Closes #1583
This PR:
config-types.tsto separate files, so that we actually only have types and simple type checks inconfig-types.ts(e.g.isMapChart),generate-json-schemascript that can be run manually via CLI or automatically on build, which generates JSON Schema files for configurator state and chart config types,Autocomplete could be tested by opening the example files in VS Code, once this PR is deployed to PROD (as the schema ids point to PROD instance for simplicity).