docs(handbook): add public company handbook article explaining philosophy#2233
docs(handbook): add public company handbook article explaining philosophy#2233ComputelessComputer merged 1 commit intomainfrom
Conversation
✅ Deploy Preview for hyprnote ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis PR updates typography across multiple content files by replacing typographic quotes and apostrophes with ASCII equivalents, adds metadata fields (author, created, published) to several article front matter, introduces a new article on public company handbooks, and makes substantive content updates to the DPA legal document including breach notification timing requirements. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Possibly related PRs
Suggested reviewers
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 |
✅ Deploy Preview for hyprnote-storybook ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 9
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/web/content/legal/dpa.mdx (1)
53-63: Breach notice + DPIA assistance + audit limits: verify operational feasibility and SCC alignment.
Line 57 (“within 72 hours where feasible”) and Line 58 (DPIA assistance) add concrete commitments; Line 62 caps audits and sets cost allocation. Please confirm (1) you can reliably meet this breach-notification SLA, (2) DPIA assistance scope is bounded (e.g., “reasonable assistance”), and (3) the audit limitation/cost allocation does not conflict with incorporated SCC audit rights or any customer commitments elsewhere. If intended, I’d recommend explicitly stating “reasonable assistance” for DPIAs and clarifying that SCC rights prevail in case of conflict.
🧹 Nitpick comments (10)
apps/web/content/articles/company-handbook-in-public.mdx (3)
41-41: Consider alternatives to "very" as an intensifier."Very good" is a commonly overused phrase. Consider more specific language like "are skilled at," "excel at," or "do a great job of" to strengthen the claim.
69-71: Reduce repetition of "It's not" sentence openings.Three consecutive sentences start with "It's not," which creates repetitive pacing. While this can be intentional for emphasis, consider varying the structure for readability:
-It's not a rulebook. +The handbook is not a rulebook. -It's not a list of corporate values. +We don't present it as a list of corporate values. It's not a finished product.
76-76: Reduce reliance on "exactly" as an intensifier.Consider replacing "that's exactly why" with more direct phrasing like "that's why," "that's precisely the point," or restructuring the sentence for stronger impact.
apps/web/content/articles/plaud-ai-alternatives.mdx (1)
31-31: Optional: fix comma splice for readability. Consider: “We shortlisted 6 AI transcription and note‑taking tools—let’s see how they compare with Plaud.”apps/web/content/vs/bear.mdx (1)
5-5: Consider quotingdescriptionin front matter for YAML robustness/consistency.apps/web/content/articles/choosing-a-cms.mdx (1)
4-4: Edits are content-only and look safe; optional: apply the LanguageTool style nits (“a lot of”, “very good”).Also applies to: 12-12, 20-24, 34-37, 65-65, 72-72, 98-100, 106-106, 110-110, 120-121, 139-140, 149-149, 164-165, 168-168, 174-174, 180-180, 199-200, 203-203, 230-230, 234-234, 246-251, 255-255, 259-261, 269-272, 275-280, 283-287, 297-297, 299-299, 301-301, 303-303, 305-306, 309-309
apps/web/content/articles/how-we-build-with-ai.mdx (1)
10-17: Use HTTPS for the GitButler link (if supported).
Line 13 useshttp://gitbutler.com; preferhttps://to avoid mixed-content / downgrade risks.apps/web/content/legal/dpa.mdx (3)
68-68: Sub-processor liability carve-out is broad; confirm it matches Terms and won’t undercut Art. 28 expectations.
Line 68 adds a limitation that liability doesn’t apply for breaches stemming from customer instructions/misuse. That may be fine, but ensure it doesn’t read like a blanket escape from sub-processor noncompliance where the processor still chose/managed the sub-processor. Consider tightening to “to the extent caused by…” language if not already standardized in your Terms.
85-86: Duplicative breach notification commitments: avoid conflicting standards across sections.
Line 85 (customer role) plus Section 8’s breach notification details overlap with Section 4’s breach clause. Consider cross-referencing a single breach-notification clause to avoid divergent obligations over time (e.g., one says “72 hours where feasible” and another enumerates contents).
185-205: Swiss addendum terminology: align “Swiss FADP” vs “revFADP” naming and defined terms.
Lines 185, 193, 200–201 mix “revFADP” and “Swiss FADP”. Consider defining one term once (e.g., “Swiss FADP (revFADP)”) and using it consistently throughout the addendum to avoid interpretive ambiguity.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
README.mdis excluded by!**/README*
📒 Files selected for processing (13)
apps/web/content/articles/bot-free-ai-meeting-assistants.mdx(1 hunks)apps/web/content/articles/choosing-a-cms.mdx(12 hunks)apps/web/content/articles/company-handbook-in-public.mdx(1 hunks)apps/web/content/articles/dont-use-a-cms.mdx(1 hunks)apps/web/content/articles/how-to-reduce-meeting-fatigue.mdx(2 hunks)apps/web/content/articles/how-we-build-with-ai.mdx(3 hunks)apps/web/content/articles/hyprnote-publishing-stack.mdx(1 hunks)apps/web/content/articles/plaud-ai-alternatives.mdx(1 hunks)apps/web/content/articles/post-yc-slump.mdx(1 hunks)apps/web/content/articles/using-ide-for-writing.mdx(1 hunks)apps/web/content/changelog/1.0.0-nightly.16.mdx(1 hunks)apps/web/content/legal/dpa.mdx(6 hunks)apps/web/content/vs/bear.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/web/content/changelog/**
📄 CodeRabbit inference engine (apps/web/content/changelog/AGENTS.md)
Only include desktop-related changes in the changelog when reading through commits and diffs
Files:
apps/web/content/changelog/1.0.0-nightly.16.mdx
🪛 LanguageTool
apps/web/content/articles/company-handbook-in-public.mdx
[style] ~41-~41: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ies Don't Write Down Most startups are very good at explaining what they're building. V...
(EN_WEAK_ADJECTIVE)
[style] ~71-~71: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e values. It's not a finished product. It's a snapshot of how we define good work...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~76-~76: Consider an alternative for the overused word “exactly”.
Context: ...n is slightly uncomfortable. And that's exactly why it matters. An Invitation If you'...
(EXACTLY_PRECISELY)
apps/web/content/articles/how-we-build-with-ai.mdx
[grammar] ~34-~34: Ensure spelling is correct
Context: ...We build with AI as the default. And Hyprnote sits right at the center of it. Every c...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~34-~34: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ecision becomes context we can revisit. Every idea gets distilled and carried forward...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
apps/web/content/articles/choosing-a-cms.mdx
[style] ~106-~106: Consider using a synonym to be more concise.
Context: ...ace include TinaCMS, Decap, etc., which a lot of devs compare as "Git-based CMS for Reac...
(A_LOT_OF)
[style] ~180-~180: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...Book](https://gitbook.com/docs) It's very good if you want: - a hosted, beautiful doc...
(EN_WEAK_ADJECTIVE)
[style] ~180-~180: This phrasing can be overused. Try elevating your writing with a more formal alternative.
Context: ...s://gitbook.com/docs) It's very good if you want: - a hosted, beautiful docs site - s...
(IF_YOU_WANT)
⏰ 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). (8)
- GitHub Check: Redirect rules - hyprnote-storybook
- GitHub Check: Header rules - hyprnote-storybook
- GitHub Check: Pages changed - hyprnote-storybook
- GitHub Check: Redirect rules - hyprnote
- GitHub Check: Header rules - hyprnote
- GitHub Check: Pages changed - hyprnote
- GitHub Check: ci
- GitHub Check: fmt
🔇 Additional comments (10)
apps/web/content/articles/using-ide-for-writing.mdx (1)
4-4: Front matter apostrophe normalization is safe (YAML + SEO).apps/web/content/articles/hyprnote-publishing-stack.mdx (1)
2-3: Title apostrophe normalization looks good and is YAML-safe.apps/web/content/articles/how-to-reduce-meeting-fatigue.mdx (1)
114-114: Typographic apostrophe normalization in body text is harmless.Also applies to: 140-140
apps/web/content/articles/dont-use-a-cms.mdx (1)
2-7: Front matter updates look consistent; please ensureauthor/created/publishedare supported by the site’s content schema.apps/web/content/articles/bot-free-ai-meeting-assistants.mdx (1)
2-3: Meta text normalization is safe and consistent with the rest of the editorial pass.apps/web/content/articles/how-we-build-with-ai.mdx (3)
32-33: ASCII quote/apostrophe normalization looks consistent here.
No MDX/Markdown formatting hazards spotted in this edit.
39-49: Section heading + contractions normalization looks consistent.
No structural changes; reads clean.
59-63: Closing paragraph edits are safe and consistent with the rest of the article.apps/web/content/articles/post-yc-slump.mdx (2)
11-11: Editorial improvements strengthen clarity and flow.The typographic normalization (curly quotes/apostrophes → ASCII) and sentence rewrites enhance readability and consistency across the article. Changes like "It felt like momentum. But it wasn't." and the rewrite about acting fast vs. moving forward better emphasize the core message about distinguishing signal from noise.
Also applies to: 19-19, 22-22, 30-30, 34-34
38-38: No issues found with<CtaCard/>usage.The component is properly defined and exported from
apps/web/src/components/cta-card.tsx. All props (title,description,buttonText,buttonUrl) are optional with appropriate defaults, so using<CtaCard/>without attributes is correct. This usage pattern is consistent with all 59 other instances across the codebase.
ComputelessComputer
force-pushed
the
docs/public-company-handbook
branch
from
c75449a to
6aa4433
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
apps/web/content/articles/company-handbook-in-public.mdx (1)
2-2: Fix double apostrophe indisplay_title.Line 2 contains
We''re(double apostrophe) which should beWe're(single apostrophe) to match the correct form in themeta_titlefield on line 3. This was flagged in the previous review and remains unresolved.-display_title: "Why We''re Publishing Our Company Handbook" +display_title: "Why We're Publishing Our Company Handbook"
🧹 Nitpick comments (4)
apps/web/content/articles/choosing-a-cms.mdx (2)
106-106: Optional: Tighten phrasing for conciseness.The phrase "a lot of devs" is casual but conversational. If you prefer tighter writing, you could consider "many developers" or "developers often compare." This is a nice-to-have refinement, not a blocker.
180-180: Optional: Strengthen the language."It's very good if you want" uses a weak intensifier and conversational framing. For a more assertive tone, you might try "It excels if you need" or "Choose GitBook when you want," depending on the desired voice. Both changes are optional style preferences.
apps/web/content/articles/company-handbook-in-public.mdx (1)
41-41: Optional: Consider style refinements for readability.The static analysis tool suggests three optional style improvements in "Chill" mode:
- Line 41:
"very good"is an over-used intensifier; consider a more specific descriptor (e.g.,"exceptionally skilled"or simply"good").- Line 71: Three consecutive sentences begin with
"It's"(lines 69–71); consider rewording one or two for variety.- Line 76: The word
"exactly"is over-used; simpler phrasing may strengthen the sentence (e.g.,"And that's why it matters.").These are stylistic preferences and not blockers, but can improve readability if you choose to address them.
Also applies to: 71-71, 76-76
apps/web/content/articles/how-we-build-with-ai.mdx (1)
34-34: Optional: Consider varying sentence starters for flow.The static analysis tool flags that three consecutive sentences begin with the word
"Every"(lines 32, 34, 34 context). While this repetition can emphasize a point, consider rewording one or two for variety if you prefer smoother pacing.For example:
"Every conversation becomes captured locally. Every decision becomes context we can revisit. Ideas get distilled and carried forward."This is a stylistic preference and not a blocker, but can improve readability.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
README.mdis excluded by!**/README*
📒 Files selected for processing (13)
apps/web/content/articles/bot-free-ai-meeting-assistants.mdx(1 hunks)apps/web/content/articles/choosing-a-cms.mdx(12 hunks)apps/web/content/articles/company-handbook-in-public.mdx(1 hunks)apps/web/content/articles/dont-use-a-cms.mdx(1 hunks)apps/web/content/articles/how-to-reduce-meeting-fatigue.mdx(2 hunks)apps/web/content/articles/how-we-build-with-ai.mdx(3 hunks)apps/web/content/articles/hyprnote-publishing-stack.mdx(1 hunks)apps/web/content/articles/plaud-ai-alternatives.mdx(1 hunks)apps/web/content/articles/post-yc-slump.mdx(1 hunks)apps/web/content/articles/using-ide-for-writing.mdx(1 hunks)apps/web/content/legal/dpa.mdx(6 hunks)apps/web/content/vs/bear.mdx(1 hunks)apps/web/public/llms.txt(2 hunks)
✅ Files skipped from review due to trivial changes (3)
- apps/web/content/vs/bear.mdx
- apps/web/content/articles/how-to-reduce-meeting-fatigue.mdx
- apps/web/content/articles/plaud-ai-alternatives.mdx
🚧 Files skipped from review as they are similar to previous changes (4)
- apps/web/content/articles/using-ide-for-writing.mdx
- apps/web/content/articles/dont-use-a-cms.mdx
- apps/web/content/articles/hyprnote-publishing-stack.mdx
- apps/web/content/articles/post-yc-slump.mdx
🧰 Additional context used
🪛 LanguageTool
apps/web/public/llms.txt
[grammar] ~59-~59: Ensure spelling is correct
Context: ...e-first capabilities. - When describing Hyprnote, avoid positioning it as a bot or autom...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
apps/web/content/articles/choosing-a-cms.mdx
[style] ~106-~106: Consider using a synonym to be more concise.
Context: ...ace include TinaCMS, Decap, etc., which a lot of devs compare as "Git-based CMS for Reac...
(A_LOT_OF)
[style] ~180-~180: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...Book](https://gitbook.com/docs) It's very good if you want: - a hosted, beautiful doc...
(EN_WEAK_ADJECTIVE)
[style] ~180-~180: This phrasing can be overused. Try elevating your writing with a more formal alternative.
Context: ...s://gitbook.com/docs) It's very good if you want: - a hosted, beautiful docs site - s...
(IF_YOU_WANT)
apps/web/content/articles/company-handbook-in-public.mdx
[style] ~41-~41: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ies Don't Write Down Most startups are very good at explaining what they're building. V...
(EN_WEAK_ADJECTIVE)
[style] ~71-~71: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e values. It's not a finished product. It's a snapshot of how we define good work...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~76-~76: Consider an alternative for the overused word “exactly”.
Context: ...n is slightly uncomfortable. And that's exactly why it matters. An Invitation If you'...
(EXACTLY_PRECISELY)
apps/web/content/articles/how-we-build-with-ai.mdx
[grammar] ~34-~34: Ensure spelling is correct
Context: ...We build with AI as the default. And Hyprnote sits right at the center of it. Every c...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~34-~34: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ecision becomes context we can revisit. Every idea gets distilled and carried forward...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ 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: ci
- GitHub Check: fmt
🔇 Additional comments (6)
apps/web/content/articles/choosing-a-cms.mdx (1)
1-8: Metadata & typography normalization looks good.Front matter is consistent, and quote/apostrophe normalization across the file will ensure consistent rendering. No accuracy or accessibility impact detected.
apps/web/content/articles/bot-free-ai-meeting-assistants.mdx (1)
2-3: LGTM!Front matter typography updates (curly quotes to ASCII equivalents) are clean and consistent with the broader PR editorial standardization.
apps/web/public/llms.txt (1)
38-42: LGTM!Typography updates (curly quotes/apostrophes → ASCII equivalents) are consistent across the file and align with the PR's editorial normalization effort. The static analysis hint regarding spelling is a false positive; "automated" is correctly spelled.
Also applies to: 57-57, 60-60
apps/web/content/legal/dpa.mdx (2)
150-150: Verify SCC competent authority language is not hardcoded to specific jurisdiction.Line 150 references
"Customer's local supervisory authority (e.g., Irish Data Protection Commission for EEA)". The previous review flagged that hardcoding specific authorities (e.g., "Irish DPC") for SCC Module 2 is incorrect because the competent authority depends on where your data exporter is established, not universally the Irish authority.Please ensure that hardcoded examples like this have been removed or updated to use generic language consistent with SCC Clause 13 mechanics, as specified in the prior review comment.
57-58: LGTM — Substantive processor obligation updates.The additions at lines 57–58 and 62 are solid improvements:
- Line 57: Explicit breach notification timing ("within 72 hours") aligns with GDPR Art. 33 requirements. ✓
- Line 58: DPIA/prior consultation support strengthens data protection compliance obligations. ✓
- Line 62: Audit frequency limits (once per calendar year, 30 days' notice) and cost allocation are reasonable and clearly stated. ✓
Also applies to: 62-62
apps/web/content/articles/how-we-build-with-ai.mdx (1)
10-11: LGTM — Strong editorial updates and content expansion.The typography normalization and content additions here strengthen the article:
- Lines 10–11, 17, 23, 32, 59–61: Typography updates (curly quotes → ASCII) are clean and consistent.
- Lines 44, 46–53: New "What's Coming Next" section with expanded bullet points provides valuable forward-looking context and hints at planned content (design cycles, team structure). This adds substance and reader engagement. ✓
The writing quality is high, and the personal voice comes through clearly.
Also applies to: 17-17, 23-23, 32-32, 44-44, 46-53, 59-61
1 participant
No description provided.