docs: sync README project structure with repository folders#5302
docs: sync README project structure with repository folders#5302princerajpoot20 merged 4 commits intoasyncapi:masterfrom
Conversation
saumyayadav2603-dot
requested review from
Mayaleeeee,
TRohit20,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg and
thulieblack
as code owners
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThe README project-structure section was updated to match the repository layout: added top-level folders ( Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #5302 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 830 830
Branches 159 159
=========================================
Hits 830 830 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 259: Add a language identifier to the unlabeled fenced code block that
contains the project tree in README.md by changing the opening triple backticks
from ``` to ```text (so the code fence is ```text ... ```), which resolves
markdownlint MD040.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5302--asyncapi-website.netlify.app/ |
|
@saumyayadav2603-dot Please add issue number .Also add a identifier as suggested by coderabbitai |
princerajpoot20
moved this from To Be Triaged
to Waiting Contributor Response
in Website - Kanban
|
@saumyayadav2603-dot please have a look at the coderabbit's suggestion |
princerajpoot20
left a comment
princerajpoot20
left a comment
There was a problem hiding this comment.
LGTM. @saumyayadav2603-dot Thanks for your contribution!
|
@bandantonio will be a quick one |
|
Hmm… I still can’t merge this PR 🧐 |
I am (my approve is green, not gray) but not of the README. So, I think, I should join your party 😁 |
|
github-project-automation
Bot
moved this from Waiting Contributor Response
to Done
in Website - Kanban
|
@saumyayadav2603-dot Thanks for your effort |
7 participants
Description
The project structure section in the README was slightly outdated and missing some directories that currently exist in the repository.
This PR updates the README to reflect the actual repository structure.
Changes
Added missing directories:
.storybookcheatsheetcypressdevelopmentdocstestsCorrected Tailwind config file name:
tailwind.config.js→tailwind.config.tsThese changes ensure the README stays synchronized with the repository structure and helps contributors better understand the project layout.
Resolves #5032
Summary by CodeRabbit