Skip to content

docs(handbook): Fix typos and improve markdown formatting#2276

Merged
ComputelessComputer merged 1 commit intomainfrom
docs/handbook-typos-formatting
Dec 13, 2025
Merged

docs(handbook): Fix typos and improve markdown formatting#2276
ComputelessComputer merged 1 commit intomainfrom
docs/handbook-typos-formatting

Conversation

@ComputelessComputer
Copy link
Collaborator

No description provided.

@netlify
Copy link

netlify bot commented Dec 13, 2025

Deploy Preview for hyprnote-storybook ready!

Name Link
🔨 Latest commit 48d8444
🔍 Latest deploy log https://app.netlify.com/projects/hyprnote-storybook/deploys/693d69f50c112c00081ee8a8
😎 Deploy Preview https://deploy-preview-2276--hyprnote-storybook.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Dec 13, 2025

Deploy Preview for hyprnote ready!

Name Link
🔨 Latest commit 48d8444
🔍 Latest deploy log https://app.netlify.com/projects/hyprnote/deploys/693d69f5c24e190008e17240
😎 Deploy Preview https://deploy-preview-2276--hyprnote.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 13, 2025

📝 Walkthrough

Walkthrough

Updated 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

Cohort / File(s) Change Summary
Company Handbook Article Content Update
apps/web/content/articles/company-handbook-in-public.mdx
Fixed display_title front matter quote formatting; converted five plain header lines to Markdown H2 headings; added inline line breaks using trailing spaces; expanded opening paragraph and culture/expectations content; enhanced "Why Put a Handbook on the Website?" section; adjusted closing sections; made minor punctuation refinements

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Content updates involve straightforward prose expansion and restructuring rather than code logic changes
  • Formatting changes (Markdown headings, inline breaks) are mechanical and consistent
  • Front matter correction is a simple character substitution

Possibly related PRs

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive No pull request description was provided by the author, so the description check cannot assess relevance to the changeset. Add a brief description explaining the typo fix and markdown formatting improvements to help reviewers understand the changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main changes: fixing a typo in the display_title and improving markdown formatting by adding headers.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/handbook-typos-formatting

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6370d63 and 48d8444.

📒 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 to display_title quoting (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

@ComputelessComputer ComputelessComputer merged commit 3abbc28 into main Dec 13, 2025
13 checks passed
@ComputelessComputer ComputelessComputer deleted the docs/handbook-typos-formatting branch December 13, 2025 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments