Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing docs for V5 of Amplify UI #4866

Closed
4 tasks done
bhelabhav opened this issue Dec 19, 2023 · 7 comments
Closed
4 tasks done

Missing docs for V5 of Amplify UI #4866

bhelabhav opened this issue Dec 19, 2023 · 7 comments
Labels
Documentation An issue or a feature-request for our Amplify UI Doc site or AWS Amplify docs feature-request Request a new feature

Comments

@bhelabhav
Copy link

bhelabhav commented Dec 19, 2023

Before creating a new issue, please confirm:

On which framework/platform are you having an issue?

Other

Which UI component?

Other

How is your app built?

Next.js

What browsers are you seeing the problem on?

Chrome

Which region are you seeing the problem in?

No response

Please describe your bug.

No way to see v5 documentation for Amplify UI Library @ https://ui.docs.amplify.aws/

What's the expected behaviour?

v5 docs are available for Amplify UI Library @ https://ui.docs.amplify.aws/

Help us reproduce the bug!

Navigate to Amplify Docs Tab:
https://docs.amplify.aws/react/

You will see a toggle for v5 vs v6.

Navigate to:
https://ui.docs.amplify.aws/

You will NOT see a toggle for v5 vs v6 - there seems to be no way to view previous documentation. Only guides on how to migrate.

Code Snippet

// Put your code below this line.

Console log output

No response

Additional information and screenshots

No response

@github-actions github-actions bot added the pending-triage Issue is pending triage label Dec 19, 2023
@bhelabhav
Copy link
Author

Why this feels like an issue:

  1. Most users still use v5 - AFAICT v5 is still a major supported version (since v6 only came out recently).
  2. All major supported versions should have readily accessible docs for users - without having to dig through the open-source lib code to learn how to build docs (asking users to act more like contributors).

Thanks for the work done to maintain the lib and consider this feedback.

Ultimately, I'm looking for a way to access v5 docs for Amplify UI even if this isn't fixed on a whole (though I strongly feel it should be addressed widely).

@esauerbo esauerbo added Documentation An issue or a feature-request for our Amplify UI Doc site or AWS Amplify docs feature-request Request a new feature and removed pending-triage Issue is pending triage labels Dec 26, 2023
@reesscot
Copy link
Contributor

reesscot commented Jan 2, 2024

Hi @bhelabhav,
Are there particular v5 docs that you're looking for? The primary changes between ui-react v5 and v6 in terms of the Authenticator are changes in the underlying JS library, along with a few prop name changes: https://ui.docs.amplify.aws/react/getting-started/migration#1-updates-to-the-authenticator

I do agree, however, that we need to add notes to the UI docs where API's have changed.

@tnurmi82
Copy link

Ok so.., I wanted to use the Accordion but I couldn't import it. I quickly noticed the docs say: "In Amplify UI v5 this was called Expander.".

Which made me realize the docs are for v6 which is apparently the latest, I'm still on v5. I can't find Expander docs anywhere. There is no version selector at the UI doc site. This is not a great developer experience. Well, luckily it's easy to create an Accordion.

@bhelabhav
Copy link
Author

bhelabhav commented Feb 8, 2024

This has since been fixed. See here:
https://docs.amplify.aws/react/prev/build-a-backend/
Screenshot 2024-02-08 at 1 01 11 PM

@reesscot
Copy link
Contributor

reesscot commented Feb 8, 2024

Hi @bhelabhav,
I'm reopening this because we are still making some changes to improve the UI docs experience for v5 users. Here's the PR that should allow us to close this issue:
#4985

@reesscot reesscot reopened this Feb 8, 2024
@github-actions github-actions bot added the pending-triage Issue is pending triage label Feb 8, 2024
@reesscot reesscot removed the pending-triage Issue is pending triage label Feb 8, 2024
@reesscot reesscot changed the title No docs for V5 of Amplify UI Missing docs for V5 of Amplify UI Feb 8, 2024
@bhelabhav
Copy link
Author

@reesscot Got it - thanks for clarifying and handling this with care. Very much appreciated.

@calebpollman
Copy link
Member

Issue resolved by #5153

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation An issue or a feature-request for our Amplify UI Doc site or AWS Amplify docs feature-request Request a new feature
Projects
None yet
Development

No branches or pull requests

5 participants