adobe / adobe/guides-extension
Documentation Issues
- Dominant language
- TypeScript
- Stars
- 3
- Forks
- 8
- Avg merge
- 23h 11m
- Merged PRs (30d)
- 1
Description
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"
Contributor guide
Research direction
Review the documentation site at https://guides-extention-feedback.vercel.app/ and inventory the Main Page, Getting Started, JUI Framework, Components, Widgets, Customisation, and ReviewApp pages. Done means the reported typos, links, unclear explanations, empty page, and AEM Guides or cloud-support gaps are corrected or clarified consistently.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100