docs: improve onboarding checklist checkbox layout #4899
Conversation
KariraLakshya
requested review from
TRohit20,
asyncapi-bot-eve 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. |
📝 WalkthroughWalkthroughReplaced Markdown checklist items with HTML Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
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 #4899 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 796 796
Branches 146 146
=========================================
Hits 796 796 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4899--asyncapi-website.netlify.app/ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In @markdown/docs/community/000-onboarding/docs-onboarding-checklist.md:
- Around line 11-22: The checklist has inconsistent spacing: the first item uses
a single <br /> while the remaining items use <br /><br />; update the markup so
all checkbox lines use the same spacing (e.g., change the first item's trailing
<br /> to <br /><br />) by normalizing the repeated <input type="checkbox" ...
/> lines to consistently end with the chosen <br /><br /> sequence so vertical
spacing is uniform across the items.
- Around line 11-22: The first checkbox line uses a single <br /> while the rest
use <br /><br />, causing inconsistent spacing; update the first checkbox line
(the line starting with <input type="checkbox" disabled style={{ transform:
'scale(1.3)', marginRight: '8px' }} /> Read the [AsyncAPI Code of Conduct]...)
to end with <br /><br /> so all checkbox lines consistently use double line
breaks (match the pattern used on subsequent lines).
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
markdown/docs/community/000-onboarding/docs-onboarding-checklist.md
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: akshatnema
Repo: asyncapi/website PR: 3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:34:51.303Z
Learning: When reviewing `scripts/markdown/check-markdown.js`, optimizations should be addressed in separate issues and not included in the current pull request.
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
- GitHub Check: Redirect rules - asyncapi-website
- GitHub Check: Header rules - asyncapi-website
- GitHub Check: Pages changed - asyncapi-website
- GitHub Check: cypress-run
- GitHub Check: Lighthouse CI
- GitHub Check: Test NodeJS PR - windows-latest
🔇 Additional comments (1)
markdown/docs/community/000-onboarding/docs-onboarding-checklist.md (1)
11-22: JSX syntax in inline styles is supported and intentional for this file.The asyncapi/website repository is configured to process
.mdfiles as MDX. The build pipeline inbuild-pages.tsautomatically transforms files from themarkdown/directory (including this file) from.mdto.mdxand applies JSX transformations. Thenext.config.mjsexplicitly enables MDX processing withextension: /\.mdx?$/, which matches both file types. The inline style syntax here is valid and fully supported.Likely an incorrect or invalid review comment.
markdown/docs/community/000-onboarding/docs-onboarding-checklist.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @markdown/docs/community/000-onboarding/docs-onboarding-checklist.md:
- Line 12: Remove the trailing whitespace characters that appear after the
closing <br /><br /> tag in the checkbox lines (the lines containing the <input
type="checkbox" disabled style={{ transform: 'scale(1.3)', marginRight: '8px' }}
/> Read the [AsyncAPI Slack
etiquette](../060-meetings-and-communication/slack-etiquette).<br /><br />
fragment) and apply the same fix to the other identical checkbox line; ensure
there are no spaces or invisible characters following the final <br /><br />.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
markdown/docs/community/000-onboarding/docs-onboarding-checklist.md
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: akshatnema
Repo: asyncapi/website PR: 3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:34:51.303Z
Learning: When reviewing `scripts/markdown/check-markdown.js`, optimizations should be addressed in separate issues and not included in the current pull request.
📚 Learning: 2024-11-25T18:34:51.303Z
Learnt from: akshatnema
Repo: asyncapi/website PR: 3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:34:51.303Z
Learning: When reviewing `scripts/markdown/check-markdown.js`, optimizations should be addressed in separate issues and not included in the current pull request.
Applied to files:
markdown/docs/community/000-onboarding/docs-onboarding-checklist.md
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: cypress-run
- GitHub Check: Test NodeJS PR - windows-latest
🔇 Additional comments (1)
markdown/docs/community/000-onboarding/docs-onboarding-checklist.md (1)
11-22: Remove the reference to issue #4864; this PR addresses only spacing inconsistency.The commit message indicates this PR fixes "Inconsistent line spacing between checklist items," not the UX concern with disabled checkboxes described in your review. Issue #4864 does not exist in the repository. The actual change normalizes
<br /><br />spacing across all 12 checklist items, which appears correctly applied in lines 11-22.Minor: Remove trailing whitespace on lines 12 and 22 (after
<br /><br />).Likely an incorrect or invalid review comment.
markdown/docs/community/000-onboarding/docs-onboarding-checklist.md
Outdated
Show resolved
Hide resolved
|
@princerajpoot20 I have completed the task in this PR and workflow failed is related to the issue #4853. Otherwise this PR is ready to be reviewed. |
|
hello @KariraLakshya i want to confirm something about the failing workflow , i dont know if you saw my latest message on that issue or not but i would like to know one thing, can you pls let me know if your forked repo was outdated like behind commits before you raised this pr i will attach a screenshot of where to look if your fork is behind below ? , i will attach you the message that i am referring too 
see like it says my branch is 1 commit behind |
|
@sammy200-ui I saw your message regarding the faling workflow but i want to confirm you that before I raised this PR my forked repo was was synced and up to date then also I faced this issue. |
|
@KariraLakshya hmm...that is weird , now that i am seeing this pr again the workflow is passing now but it was not passing yesterday , i might need to check other prs . Thank you for the response and confirmation !! |
yes it is passing now !! |
princerajpoot20
left a comment
princerajpoot20
left a comment
There was a problem hiding this comment.
We cannot go ahead with this approach. The reason is that if you view the .md file as a standalone file, it does not look good. So we cannot make changes to the .md file in the way you have done.
Also, just FYI: you cannot make changes to docs under the community section. it is managed from the community repo
|
@princerajpoot20 my suggestion was, |
5 participants
Description
This PR removes bullet points from the onboarding checklist, which previously contained both checkboxes and bullets.
What was changed:
Why this change:
No functional behavior was added or modified.
Screenshots
Related issue(s)
Fixes #4864
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.