chore(api-docs-template): Update ApiModal styling/markup. Move breadcrumbs to ApiModalBreadcrumbs #7956
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
jacoblogan
approved these changes
Sep 10, 2024
jacoblogan
added a commit
that referenced
this pull request
Sep 27, 2024
* initial template implementation * additional template functionality * update modal * add api references json * add api categories * update to template and display * revert changes to dev script * pass references to components * remove build cache * remove pass through references * clean references * add categories into clean references * update references * update references with correct categories * update references * cleaned references * update to clean references * update header and Toc * update directories * update generate directory * add sub categories * move references and rename to raw-references * update api docs template * undo unwanted changes * remove colons, some type updates, add keys (#7952) * update TypeLink to output a button (#7953) * chore(api-docs-template): Update ApiModal styling/markup. Move breadcrumbs to ApiModalBreadcrumbs (#7956) * update Modal styling/ add Breadcrumbs * remove commented out code * update to generateDirectory to add api reference pages (#7950) Co-authored-by: Jacob Logan <[email protected]> * add getApiStaticPath util function (#7949) * add getApiStaticPath util function * add typing * update type and comment on paths --------- Co-authored-by: Jacob Logan <[email protected]> * parse out markdown links in comments * update link to display literal type * Feature/api docs workflow (#7948) * update api disapatch workflow * set github commit user in workflow * update references file name * rename raw and clean references * update workflow add comments to clean script --------- Co-authored-by: Jacob Logan <[email protected]> * add dark mode to modal description text * update api function returns to use typeParameters * remove space in promise display * close modal when click outside modal (#7969) Co-authored-by: katiegoines <[email protected]> * focus modal on open (#7970) Co-authored-by: katiegoines <[email protected]> * fix typo; * fix error in modal close * format "Returns" as code (#7971) * . * format Returns as code --------- Co-authored-by: katiegoines <[email protected]> * add api link legend * update breadcrumbs separator, render nested typeArgs, render nested arraytypes * add function type display * add error type * update api legend and link colors * update cleaned references location * update base references files * update scroll behavior * reverting uneeded changes to base.scss * update formatting * add spacing to breadcrumbs * remove extra space and add legend header * add formatting to api comments (#8000) Co-authored-by: Jacob Logan <[email protected]> * update list parsing --------- Co-authored-by: Jacob Logan <[email protected]> Co-authored-by: Heather Buchel <[email protected]> Co-authored-by: Katie Goines <[email protected]> Co-authored-by: katiegoines <[email protected]>
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:
CleanShot.2024-09-10.at.12.39.25.mp4
Related GitHub issue #, if available:
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.