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

Documentation Issues #6

Open
rohitpruthi95 opened this issue Aug 1, 2023 · 1 comment
Open

Documentation Issues #6

rohitpruthi95 opened this issue Aug 1, 2023 · 1 comment

Comments

@rohitpruthi95
Copy link

Issues in documentation - https://guides-extention-feedback.vercel.app/

Main Page

  1. Typo in word - "Extention" (also in URL)
  2. The home page mentions "Docusaurus" and has references to the template (not sure if intentional)

Getting Started

  1. The installation link is present twice both pointing towards different pages. In general there are 2 installation pages where one is incomplete.
  2. The installation doesn't mention anything about AEM Guides (for example which versions are supported etc), until the step "Go to CRXDE" is directly introduced. This also won't work for cloud customers.
  3. Typo in words - "gudies" and "modulde" on the page "Extension Repository Introduction"

JUI Framework

  1. In the App/Global Model category, the line - "First time get old value" is not clear.
  2. The "Controller" category is not clear. There are various bullets like "APIs" which do not explain anything.
  3. Grammatical errors in - "App is a Widgets", "Is a HTML/React Component", "its uses parent widget model", "can have an own"

Components

  1. The description in the main page shows - "The button component in JUI represents a html ``.
  2. Label - typo in "componenent"
  3. html is prefixed with "a" instead of "an" everywhere

Widgets

  1. Typo in "referncing". "th",

Customisation

  1. In the "Simple customisation example", the tcx.appGet and tcx.model call is not explained and not very clear (or in general how controller function is working here).
  2. "Customising topbar and toolbar" page is empty

ReviewApp

  1. Typo in "attrubute", "importnant"
@paridhivijay
Copy link

We have described very few components in the documentation; giving the link to the react-spectrum storybook could be useful and give more readily available information.
https://react-spectrum.corp.adobe.com/storybook/?path=/story/button-interactive--regular-button

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants