Feature/api docs #7990
Merged
Feature/api docs #7990
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
…rumbs to ApiModalBreadcrumbs (#7956) * update Modal styling/ add Breadcrumbs * remove commented out code
Co-authored-by: Jacob Logan <lognjc@amazon.com>
* add getApiStaticPath util function * add typing * update type and comment on paths --------- Co-authored-by: Jacob Logan <lognjc@amazon.com>
jacoblogan
requested review from
a team,
aspittel and
swaminator
as code owners
timngyn
reviewed
Sep 24, 2024
timngyn
reviewed
Sep 24, 2024
jordanvn
reviewed
Sep 24, 2024
jordanvn
reviewed
Sep 24, 2024
jordanvn
reviewed
Sep 24, 2024
timngyn
reviewed
Sep 24, 2024
jimblanc
reviewed
Sep 24, 2024
jordanvn
reviewed
Sep 25, 2024
esauerbo
previously approved these changes
Sep 25, 2024
jordanvn
reviewed
Sep 25, 2024
timngyn
previously approved these changes
Sep 25, 2024
There was a problem hiding this comment.
Looks good to me! Approved for now but will need a followup for the following:
Talked to @jacoblogan about how at the moment there aren't any tests to notify the team of breaking changes to the typdoc json format.
If the the format changes and the API docs don't find the content then nothing gets displayed on the API docs pages. Someone would need to check the API docs pages to see that something is wrong with the format. There should be tests in place so that the team can be alerted when this kind of change happens
Co-authored-by: Jacob Logan <lognjc@amazon.com>
jordanvn
approved these changes
Sep 26, 2024
timngyn
approved these changes
Sep 27, 2024
aspittel
approved these changes
Sep 27, 2024
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.
Description of changes:
Add js api docs to the docs site. This includes the base api json that's needed to render the docs and will be updated automatically by the workflow.
Staging site: https://feature-api-docs.dmhjrabi3pkql.amplifyapp.com/
Related GitHub issue #, if available:
Previous PRs merged into the feature/api-docs branch
#7948
#7949
#7950
#7941
Instructions
If this PR should not be merged upon approval for any reason, please submit as a DRAFT
Which product(s) are affected by this PR (if applicable)?
Which platform(s) are affected by this PR (if applicable)?
Please add the product(s)/platform(s) affected to the PR title
Checks
Does this PR conform to the styleguide?
Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.
Are any files being deleted with this PR? If so, have the needed redirects been created?
Are all links in MDX files using the MDX link syntax rather than HTML link syntax?
ref: MDX:
[link](https://docs.amplify.aws/)HTML:
<a href="https://docs.amplify.aws/">link</a>When this PR is ready to merge, please check the box below
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.