Skip to content

Very small typo on writing-product-docs.mdx #21309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nikhil-vytla wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Very small typo on writing-product-docs.mdx #21309

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion contents/handbook/wizard-and-docs/writing-product-docs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
showTitle: true
---

This guide explains how to write and structure your tool's documentation. A **tool** is a PostHog capability like support, error tracking, or product analytics. We used to call these "products" or "apps".

Check warning on line 7 in contents/handbook/wizard-and-docs/writing-product-docs.mdx

View workflow job for this annotation

GitHub Actions / Lint prose with Vale

Vale PostHogBase.ProductNames 

Capitalize 'Product Analytics' for PostHog's product. Use 'product analytics' for the general industry concept.

Check warning on line 7 in contents/handbook/wizard-and-docs/writing-product-docs.mdx

View workflow job for this annotation

GitHub Actions / Lint prose with Vale

Vale PostHogBase.ProductNames 

Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept.

The structure in this guide shows users how a tool feeds [self-driving](/docs/self-driving), so it follows [PostHog's four layers](/handbook/brand/foundations):

Expand All @@ -16,7 +16,7 @@

<CalloutBox icon="IconInfo" title="Some docs won't fit this structure" type="fyi">

The structrure outlined in this guide is intended for **tool**-specific docs. Some docs, like API and SDK references, won't fit nicely in this box. That's okay. Refer to the other Wizard & Docs handbook pages for how to write [onboarding](/handbook/wizard-and-docs/onboarding-docs), [SDK](/handbook/wizard-and-docs/sdk-reference-docs), and [API](/handbook/wizard-and-docs/api-specifications) docs.
The structure outlined in this guide is intended for **tool**-specific docs. Some docs, like API and SDK references, won't fit nicely in this box. That's okay. Refer to the other Wizard & Docs handbook pages for how to write [onboarding](/handbook/wizard-and-docs/onboarding-docs), [SDK](/handbook/wizard-and-docs/sdk-reference-docs), and [API](/handbook/wizard-and-docs/api-specifications) docs.

</CalloutBox>

Expand Down Expand Up @@ -120,7 +120,7 @@

<CalloutBox icon="IconInfo" title="SDK installation pages" type="fyi">

SDK installation pages share a special architecture: they render the same content as the in-app onboarding flow, with the source of truth in the [posthog/posthog monorepo](https://github.com/PostHog/posthog/tree/master/docs/onboarding) pulled in automatically. The installation index auto-generates a grid of platform cards via `usePlatformList()`, sorted by `src/navs/index.js` order, with logos from each page's `platformLogo` frontmatter. See the [onboarding docs handbook](/handbook/wizard-and-docs/onboarding-docs) for setup.

Check warning on line 123 in contents/handbook/wizard-and-docs/writing-product-docs.mdx

View workflow job for this annotation

GitHub Actions / Lint prose with Vale

Vale Vale.Terms 

Use 'PostHog' instead of 'posthog'.

</CalloutBox>

Expand All @@ -139,7 +139,7 @@

## Context

This is the data that feeds your tool, and where it comes from. Unlike Surfaces, this section's name changes per tool: Support splits it into **Channels** (where tickets come from) and **Imports** (history brought in from tools like Zendesk); another tool might call it Sources, Inputs, or Signals. In-depth "How X works" explainers live here too, attached to the data they describe.

Check warning on line 142 in contents/handbook/wizard-and-docs/writing-product-docs.mdx

View workflow job for this annotation

GitHub Actions / Lint prose with Vale

Vale PostHogBase.Spelling 

'explainers' is a possible misspelling.

Include the following in your pages here:

Expand Down
Loading