docs(handbook): Fix typos and improve markdown formatting#2276
docs(handbook): Fix typos and improve markdown formatting#2276ComputelessComputer merged 1 commit intomainfrom
Conversation
✅ Deploy Preview for hyprnote-storybook ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for hyprnote ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughUpdated an MDX article's front matter display_title, restructured content headers from plain text to Markdown H2 headings, added inline line breaks for readability, expanded several sections with additional context, and made minor punctuation adjustments. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes
Possibly related PRs
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
apps/web/content/articles/company-handbook-in-public.mdx (1)
24-24: Hard line breaks via trailing double-spaces may get stripped by formatters—consider explicit<br />in MDX.
If Prettier/remark config trims trailing whitespace, these line breaks will silently disappear. Using<br />is more robust in MDX.-The first was straightforward: requirements. +The first was straightforward: requirements.<br /> -The second was harder to write: expectations. -How decisions are actually made. -What ownership really means. +The second was harder to write: expectations.<br /> +How decisions are actually made.<br /> +What ownership really means.<br /> -It's not a list of corporate values. +It's not a list of corporate values.<br /> -And if you're reading this as a contributor, user, or future teammate: -this handbook is our attempt to show how we think, not just what we build. +And if you're reading this as a contributor, user, or future teammate:<br /> +This handbook is our attempt to show how we think, not just what we build.Also applies to: 27-29, 34-34, 67-67, 82-83
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
apps/web/content/articles/company-handbook-in-public.mdx(5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: Redirect rules - hyprnote
- GitHub Check: Header rules - hyprnote
- GitHub Check: Pages changed - hyprnote
- GitHub Check: fmt
- GitHub Check: ci
🔇 Additional comments (2)
apps/web/content/articles/company-handbook-in-public.mdx (2)
2-2: Good fix todisplay_titlequoting (double-apostrophe → apostrophe).
No concerns.
18-18: H2 conversion is a net win; verify it matches the site’s TOC/anchor expectations.
If the renderer auto-builds a TOC or relies on specific heading levels, confirm these new##headings don’t change styling/anchors unintentionally.Also applies to: 37-37, 51-51, 63-63, 76-76
No description provided.