fix: improve API reference URLs #720
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
Signed-off-by: github-actions <github-actions@github.com>
MrArnoldPalmer
approved these changes
Jan 20, 2022
MrArnoldPalmer
added a commit
that referenced
this pull request
Jan 21, 2022
Revert change in api url generation and version of jsii-docgen. This reverts commit 9dc9837.
mergify bot
pushed a commit
that referenced
this pull request
Jan 27, 2022
See #720 for original context. Compared to the original PR, this adds the following fixes: - reduces the size of the output of the transliterator handler by taking the created/deleted `S3Object` arrays and only returning the keys instead. This is needed to prevent failures caused by the output being too large. - fixes logic for the linkFormatter and updates it to give incorrect error messages TODO: update jsii-docgen version once cdklabs/jsii-docgen#571 is merged ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
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.
Improve the API reference URLs by using markdown files generated by jsii-docgen@5.
This PR updates the transliterator to generate both
docs-<lang>.mdanddocs-<lang>.jsonfiles (including two.corruptedassemblyor.corruptedassemblymarkers for each language where appropriate). Canary metrics continue to be generated based on.mdfiles.In addition, generate
docs-xxx.jsonfiles in the backend so that we can move towards using the JSON format for rendering API references on the frontend in the future.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license