Megaissue Q2 2024: Docs update

[ivanagas]

From our team goals: https://posthog.com/teams/marketing#goals

Some of our documentation has fallen behind the product and there are pockets that fall well short of our current standards. This is a reputational risk if left unresolved.

The following are links to docs that are out-of-date or low quality based on:

1. My experience + what’s popular (docs, tutorials)
2. Voted “not helpful” the most
3. Most people asking comment

To make these better, we should:

• Carefully review them
• Simplify and remove duplication where possible
• Match functionality in app
• Use questions section as guide and answer what’s unclear

Major

Major updates or rewrites needed. Haven’t been updated in long time, are big important docs pages, make readers unhappy.

• [x] https://posthog.com/docs/data/sessions - @ivanagas
  • https://github.com/PostHog/posthog.com/issues/8114
  • Wait for some session property work to land
• [x] https://posthog.com/docs/product-analytics/funnels @Lior539
  • Combine with https://posthog.com/tutorials/guide-to-funnels
• [x] https://posthog.com/docs/product-analytics/dashboards @andyvan-ph
• [x] https://posthog.com/docs/product-analytics/paths @Lior539
  • https://posthog.slack.com/archives/C0368RPHLQH/p1712778223399069
• [x] https://posthog.com/docs/product-analytics/stickiness @Lior539
• [x] https://posthog.com/docs/product-analytics/correlation @Lior539
  • https://github.com/PostHog/posthog.com/issues/7949
• [x] https://posthog.com/docs/product-analytics/retention @andyvan-ph
• [x] https://posthog.com/docs/product-analytics/lifecycle - @Lior539
• [x] https://posthog.com/docs/api/query - @ivanagas
• [x] https://posthog.com/docs/libraries/docusaurus - @ivanagas
• [x] https://posthog.com/docs/data/events - @ivanagas
• [x] https://posthog.com/docs/advanced/cdp - @ivanagas
• [ ] ~https://posthog.com/docs/webhooks~
  • Wait for new webhooks to update
• [x] https://posthog.com/docs/product-analytics/subscriptions - @ivanagas

Minor

Review and make minor edits, tweaks, and improvements as needed. For example, some of these haven’t been edited by the marketing team.

• [x] https://posthog.com/docs/product-analytics/trends @andyvan-ph
• [x] https://posthog.com/docs/product-analytics/user-properties - @ivanagas
  • Wait for person profiles to update
• [x] https://posthog.com/docs/product-analytics/autocapture - @ivanagas
• [x] https://posthog.com/docs/api/post-only-endpoints - @ivanagas
• [x] https://posthog.com/docs/api/persons - @ivanagas
• [x] https://posthog.com/docs/data - @Lior539
• [x] https://posthog.com/docs/data/cohorts - @Lior539
• [x] https://posthog.com/docs/data/persons - @Lior539
• [x] https://posthog.com/docs/product-analytics/sharing - @ivanagas
• [x] https://posthog.com/docs/session-replay/iframes - @ivanagas
• [x] https://posthog.com/docs/session-replay/console-log-recording - @ivanagas
• [x] https://posthog.com/docs/session-replay/canvas-recording - @ivanagas
• [x] https://posthog.com/docs/feature-flags/bootstrapping - @Lior539
• [x] https://posthog.com/docs/feature-flags/multi-project-feature-flags - @Lior539
  • Likely some comparisons/alternatives needing this update too
• [x] https://posthog.com/docs/feature-flags/scheduled-flag-changes - @Lior539
  • Likely some comparisons/alternatives needing this update too
• [x] https://posthog.com/docs/experiments/creating-an-experiment - @Lior539
• [x] https://posthog.com/docs/libraries/react-native - @Lior539
• [x] https://posthog.com/docs/surveys/creating-surveys - @ivanagas
• [x] https://posthog.com/docs/surveys/implementing-custom-surveys - @ivanagas

Tutorials

I’ve also included these as they are popular, but out-of-date and need major rewrites.

• [x] https://posthog.com/tutorials/multiple-environments - @Lior539
• [x] https://posthog.com/tutorials/single-page-app-pageviews - @ivanagas
• [x] https://posthog.com/tutorials/guide-to-funnels - @Lior539
  • Merge with https://posthog.com/docs/product-analytics/funnels
• [ ] https://posthog.com/tutorials/scroll-depth - @Lior539
• [x] https://posthog.com/tutorials/event-tracking-guide - @ivanagas
• [x] https://posthog.com/tutorials/cookieless-tracking - @ivanagas

Other parts of Q2 docs goals are covered by other issues like https://github.com/PostHog/posthog.com/issues/6905, https://github.com/PostHog/posthog.com/issues/8155, and https://github.com/PostHog/posthog.com/issues/7738

[andyvan-ph]

I've put my name against a few of the above, mostly ones I planned to look at before but ran out of time on.

[Lior539]

@ivanagas I have capacity to take on docs stuff. Are there any chunks of work here you'd like me to take on?

[ivanagas]

@ivanagas I have capacity to take on docs stuff. Are there any chunks of work here you'd like me to take on?

Do you want to take on paths, correlation, and stickiness for now?

[Lior539]

Yes that sounds good. Will get to it after the offsite

[Lior539]

@ivanagas I'm mostly done with the items assigned to me. Would you like me to take on more docs work? If so, which ones?

[ivanagas]

Tagged you in some more (all the feature flag and experiment ones) @Lior539

[Lior539]

@ivanagas I can take on some more. Let me know which ones

[ivanagas]

Tagged you in https://posthog.com/docs/libraries/react-native, https://posthog.com/docs/product-analytics/lifecycle, and https://posthog.com/tutorials/scroll-depth (needs update to account for web analytics, scroll maps, posthog-js capturing this data on pageleave events automatically).

[Lior539]

@ivanagas I've put my name next to /docs/data and /docs/data/cohorts too

Edit: also added /docs/data/persons too since this page annoys me