docs: sort the 1.0.0 migration guide, and add the facts from the retired posthog.com Rust page by gewenyu99 · Pull Request #362 · PostHog/posthog-rs

gewenyu99 · 2026-11-12T17:00:06Z

Fill missing docstring details from migration guides and old docs.
Make migration guides easier to read.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

veria-ai · 2026-11-12T17:00:26Z

PR overview

No security issues were found in this pull request.

Reviews

c37ba32 — No new issues
ad64ee7 — No new issues
9e8fc3a — No new issues

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

posthog

PostHog Review · Standard · reviewed fbd7ac3: 1 Should fix.

See this review and its findings in PostHog Review. Comment @posthog review --deep for a Deep review. A Deep review takes longer and looks deeper than a Standard review.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> (cherry picked from commit ceaf19c)

The posthog.com Rust SDK page redirects to this reference once 1.0.0 ships, so its setup, how-to, and feature flag sections now live in docs/getting-started.md. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> (cherry picked from commit 7776e30)

This reverts commit b15476c.

…her page has Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

The reference renders each doc comment under its entry, per major, so facts about one API belong there. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

posthog

PostHog Review · Standard · reviewed a073d95: 1 Should fix.

dustinbyrne

The migration checklist restructuring and single-guide title handling look sound. Two optional documentation improvements inline: document the logging dependency/feature and retain a brief backend-availability reminder.

AI-assisted review.

…rted guide Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

…ample Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

posthog

PostHog Review · Standard · reviewed 9e8fc3a: 2 Should fix. This pull request is large, so the review ran in 4 parts with less depth than usual.

This is review round 3 on this pull request. When findings keep coming back in the same code, the approach is usually the problem. Before the next fix, check whether a different design would remove the whole class of findings.

…on-guide-structure Stacks the sorted guide on the identify-style person processing default, which also carries the Rust 1.100 Clippy fix. The guide keeps the sorted text. References regenerated. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>

posthog

PostHog Review · Standard · reviewed ad64ee7: no findings. This pull request is large, so the review ran in 4 parts with less depth than usual.

Proxy pass-through and redirect fixes, flush and shutdown on both lanes, how a null property fills, and a `$set` in the request context. Points the shared capture v1 link at the API reference. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>

… ignored The guide said a $process_person_profile property wins over the personless false on any event with a generated distinct ID. It does not when the request context was already applied by hand: RequestContext::event applies it while building the event. The option works there. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>

Each rustdoc intra-doc link pointed at a slug of its link text, such as `crate::Client::alias` -> #crateclientalias, which no heading on the page has. The generator now labels every heading first and points a link at its target's heading by rustdoc id, or at the type that lists a field or variant. A target with no heading, such as `Client` or `Default`, stays plain code. Links are written inline, since `Self::code` means a different item on each type. All 142 links on the 1.x page now land on a heading, down from 19 dead `#` links and 26 rustdoc paths. docs/capabilities.json still mapped four `Client` flag methods that 1.x removed, so a 1.0.0 run, which checks for stale keys, exited before writing any page. The next-major page no longer gets an " (experimental)" title. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Regenerated from docs/migration-guide-structure (#362) at 1.0.0 after its generator fix. Every intra-doc link now lands on a heading on the page, and links whose target has no heading, such as `Client`, are plain code. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Vincent ruled out self-hosted framing in the guides, and the endpoint and 404 sentences read as self-host framing. The retry tables and the proxy notes stay. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

…369) * docs: publish the posthog-rs 1.x reference and migration guide pages Adds references/posthog-rust-1.md and references/posthog-rust-migration.md as the 1.0.0 release will write them, so the Strapi sync puts them on posthog.com before 1.0.0 ships. Both come from running scripts/generate_markdown.py on docs/migration-guide-structure (#362) with the crate at 1.0.0, the version the release sets before it generates. The generator on main writes only the 0.x page and the reference page, and skips the migration page without docs/migration-*.md, so neither file is rewritten before the release. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs: point the Rust 1.x reference's intra-doc links at their headings Regenerated from docs/migration-guide-structure (#362) at 1.0.0 after its generator fix. Every intra-doc link now lands on a heading on the page, and links whose target has no heading, such as `Client`, are plain code. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs: regenerate the migration page without the 404 hint and self-hosted lines Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

docs: sort the Rust 1.0.0 migration guide by when you make each change

4d13f9d

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

gewenyu99 requested a review from a team as a code owner November 12, 2026 17:00

gewenyu99 self-assigned this Nov 12, 2026

docs: keep the 1.0.0 guide's table cells to one value

fbd7ac3

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

posthog Bot reviewed Nov 12, 2026

View reviewed changes

Comment thread docs/migration-0.x-to-1.0.md Resolved

gewenyu99 marked this pull request as draft November 12, 2026 17:36

gewenyu99 and others added 3 commits November 12, 2026 12:46

Merge eli/v1-sync-main-20261111 into docs/migration-guide-structure

e8b8738

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

docs: title a single migration guide's page with its H1

3bbef50

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> (cherry picked from commit ceaf19c)

gewenyu99 changed the base branch from v1 to eli/v1-sync-main-20261111 November 12, 2026 17:46

gewenyu99 changed the title ~~docs: sort the Rust 1.0.0 migration guide by when you make each change~~ docs: sort the 1.0.0 migration guide, and move the posthog.com Rust page into the reference Nov 12, 2026

This was referenced Nov 12, 2026

docs: title the migration page with its H1, and move the posthog.com SDK page into the reference #361

Closed

[Waiting on SDK releases] feat(docs): replace the SDK pages with their Markdown references PostHog/posthog.com#22061

Open

gewenyu99 and others added 2 commits November 12, 2026 12:51

Revert "docs: move the posthog.com Rust SDK page into the reference"

afe6324

This reverts commit b15476c.

docs: add the Rust facts from the retired posthog.com page that no ot…

7be4df4

…her page has Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

gewenyu99 changed the title ~~docs: sort the 1.0.0 migration guide, and move the posthog.com Rust page into the reference~~ docs: sort the 1.0.0 migration guide, and add the facts from the retired posthog.com Rust page Nov 12, 2026

docs: move the Rust one-API facts from getting-started into doc comments

a073d95

The reference renders each doc comment under its entry, per major, so facts about one API belong there. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

gewenyu99 marked this pull request as ready for review November 12, 2026 18:50

posthog Bot reviewed Nov 12, 2026

View reviewed changes

Comment thread docs/getting-started.md Resolved

Base automatically changed from eli/v1-sync-main-20261111 to v1 November 12, 2026 19:02

dustinbyrne approved these changes Nov 12, 2026

View reviewed changes

Comment thread docs/getting-started.md Resolved

Comment thread docs/migration-0.x-to-1.0.md Resolved

eli-r-ph and others added 6 commits November 12, 2026 14:55

docs: restore the self-hosted, 404 and duplicate-uuid notes in the so…

002393c

…rted guide Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

docs: describe the identify-style person processing default in the so…

7a52fdb

…rted guide Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

docs: correct the tracing filter setup and the web server shutdown ex…

9491444

…ample Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

docs: regenerate the 1.x and migration references

82a1fd4

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

docs: say how to keep an identify-style event personless

a23550f

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

docs: regenerate the migration reference

9e8fc3a

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

posthog Bot reviewed Nov 12, 2026

View reviewed changes

Comment thread docs/migration-0.x-to-1.0.md Resolved

Comment thread docs/migration-0.x-to-1.0.md Resolved

eli-r-ph changed the base branch from v1 to eli/v1-identify-style-person-default November 13, 2026 00:57

eli-r-ph and others added 2 commits November 12, 2026 17:00

docs: show Event::alias returning a Result in the guide

ad64ee7

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>

posthog Bot reviewed Nov 13, 2026

View reviewed changes

eli-r-ph approved these changes Nov 13, 2026

View reviewed changes

eli-r-ph and others added 2 commits November 12, 2026 18:05

gewenyu99 mentioned this pull request Nov 13, 2026

docs: publish the posthog-rs 1.x reference and migration guide pages #369

Merged

3 of 5 tasks

docs: cut the 404 hint and self-hosted lines from the migration guide

66ed402

Vincent ruled out self-hosted framing in the guides, and the endpoint and 404 sentences read as self-host framing. The retry tables and the proxy notes stay. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

eli-r-ph merged commit 66ed402 into eli/v1-identify-style-person-default Nov 13, 2026
26 of 27 checks passed

eli-r-ph deleted the docs/migration-guide-structure branch November 13, 2026 21:52

Navigation Menu

Repository navigation

docs: sort the 1.0.0 migration guide, and add the facts from the retired posthog.com Rust page - #362

docs: sort the 1.0.0 migration guide, and add the facts from the retired posthog.com Rust page#362
eli-r-ph merged 20 commits into
eli/v1-identify-style-person-defaultfrom
docs/migration-guide-structure

gewenyu99 commented Nov 12, 2026 •

edited

Loading

Uh oh!

veria-ai Bot commented Nov 12, 2026 •

edited

Loading

Uh oh!

posthog Bot left a comment

Uh oh!

Uh oh!

posthog Bot left a comment

Uh oh!

Uh oh!

dustinbyrne left a comment

Uh oh!

Uh oh!

Uh oh!

posthog Bot left a comment

Uh oh!

Uh oh!

Uh oh!

posthog Bot left a comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

gewenyu99 commented Nov 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

veria-ai Bot commented Nov 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR overview

Reviews

Uh oh!

posthog Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

posthog Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dustinbyrne left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

posthog Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

posthog Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gewenyu99 commented Nov 12, 2026 •

edited

Loading

veria-ai Bot commented Nov 12, 2026 •

edited

Loading