Handbook: Writing blogs as an engineer#17334
Merged
Merged
Conversation
Contributor
Deploy preview
|
Contributor
|
Vale prose linter → found 13 errors, 16 warnings, 1 suggestions in your markdown Full report → Copy the linter results into an LLM to batch-fix issues. Linter being weird? Update the rules!
|
| Line | Severity | Message | Rule |
|---|---|---|---|
| 7:223 | warning | 'Blitzscale' is a possible misspelling. | PostHogBase.Spelling |
| 11:49 | warning | 'Blitzscale' is a possible misspelling. | PostHogBase.Spelling |
| 12:107 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 12:171 | warning | 'Blitzscale' is a possible misspelling. | PostHogBase.Spelling |
| 12:366 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 13:149 | warning | 'Blitzscale' is a possible misspelling. | PostHogBase.Spelling |
| 16:191 | suggestion | Prefer 'proper nouns or they' over 'he'. | PostHogBase.Inclusivity |
| 18:119 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 69:24 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 81:91 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 105:12 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 107:23 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 116:75 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 117:70 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 118:24 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 120:75 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 124:4 | warning | 'FAQ' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 128:243 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 132:45 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
contents/handbook/engineering/writing-blogs.md — 0 errors, 9 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 11:64 | warning | 'Karpathy's' is a possible misspelling. | PostHogBase.Spelling |
| 11:75 | warning | 'Autoresearch' is a possible misspelling. | PostHogBase.Spelling |
| 11:225 | warning | 'Tokio' is a possible misspelling. | PostHogBase.Spelling |
| 11:335 | warning | 'learnings' is a possible misspelling. | PostHogBase.Spelling |
| 13:125 | warning | Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. | PostHogBase.ProductNames |
| 57:40 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 65:47 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 67:88 | warning | 'Bluesky' is a possible misspelling. | PostHogBase.Spelling |
| 67:213 | warning | 'upvotes' is a possible misspelling. | PostHogBase.Spelling |
contents/handbook/engineering/writing-docs.md — 0 errors, 2 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 17:4 | warning | 'What about the so-called Docs & Wizard team?' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 61:127 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
jina-yoon
reviewed
Jun 5, 2026
jina-yoon
reviewed
Jun 5, 2026
jina-yoon
reviewed
Jun 5, 2026
jina-yoon
reviewed
Jun 5, 2026
jina-yoon
reviewed
Jun 5, 2026
jina-yoon
reviewed
Jun 5, 2026
jina-yoon
reviewed
Jun 5, 2026
jina-yoon
approved these changes
Jun 5, 2026
jina-yoon
left a comment
jina-yoon
left a comment
Contributor
There was a problem hiding this comment.
tiny edits + added a few examples of good eng blogs in the past
Co-authored-by: Jina Yoon <jina@posthog.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
As part of https://github.com/PostHog/company-internal/issues/3076, a handbook page about writing blogs for engineers.
Checklist