[📑 Docs]: An audit across our docs
- Dominant language
- JavaScript
- Stars
- 138
- Forks
- 178
- PR merge metrics
- No merged PRs in 30d
Description
### What Dev Docs changes are you proposing?
We need help conducting an audit of our website docs. This includes identifying all non-functional links and correcting any incorrect paths.
Additionally, we need to review the local documentation in the README and use the GitHub bot to identify any inconsistencies.
Once the audit is complete and the documents that require link updates have been identified, the next phase will be to update those links.
To contribute to this issue, make sure to complete the [TW onboarding and checklist docs](https://www.asyncapi.com/docs/community/000-onboarding/docs-onboarding-checklist)
### Code of Conduct
- [x] I agree to follow this project's Code of Conduct
### Are you willing to work on this issue ?
No, someone else can work on it
Contributor guide
Research direction
Complete the TW onboarding and checklist docs first. Audit the website documentation and local README for non-functional links, incorrect paths, and inconsistencies identified with the GitHub bot. Done means the affected documents and link updates are identified for the next phase.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100