Repository navigation
docs: update feedback and design.md links in READMEs - #1056
victoreronmosele wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates repository and issue tracker links in the README files to point to the new 'a2ui-project/a2ui' repository, and corrects the relative path to the design document. The feedback suggests improving the readability and accessibility of the design document link by using more descriptive text instead of the literal filename.
Note: Security Review has been skipped due to the limited scope of the PR.
| ``` | ||
|
|
||
| See [DESIGN.md](./DESIGN.md) for more detailed information about the design. | ||
| See [design.md](../../docs/contributing/design.md) for more detailed information about the design. |
There was a problem hiding this comment.
Using the literal filename 'design.md' as the link text is less descriptive. It is better to use more natural, descriptive text for links to improve readability and accessibility.
| See [design.md](../../docs/contributing/design.md) for more detailed information about the design. | |
| See the [design document](../../docs/contributing/design.md) for more detailed information. |
There was a problem hiding this comment.
It was previously DESIGN.md and I just changed it to match the new file name.
I'll leave this decision to the maintainers.
Description
This PR updates the README feedback links to the A2UI repo and updates the design.md link to its new location.
Fixes: a2ui-project/a2ui#1888
Related: #953
Pre-launch Checklist
///). N/AIf you need help, consider asking for advice on the #hackers-devrel channel on Discord.