Skip to content

Add docs for v1 Python and JavaScript SDKs (beta) - #29

Merged
itssimon merged 39 commits into
mainfrom
v1-sdks
Sep 15, 2026
Merged

itssimon merged 39 commits into
mainfrom
v1-sdks

Conversation

@itssimon

@itssimon itssimon commented Sep 13, 2026

Copy link
Copy Markdown
Member

Summary by cubic

Adds beta documentation for the v1 Python and JavaScript SDKs and reorganizes the SDK reference so each SDK's docs live under versioned paths.

New Features

  • Adds v1 reference pages for overview, configuration, masking, sampling, tracing, and attributes, covering handled exception capture and application log masking.
  • Adds v1 setup guides with documented version and framework requirements for all supported Python and JavaScript frameworks.
  • Adds v1 migration guides covering the switch from client IDs to write tokens and behavior changes like request logging being enabled by default.

Migration

  • Existing v0 pages moved to /sdk-reference/<language>/v0/... paths, so previously published URLs will change; navigation and internal links were updated to match.

Written for commit 3ffb582. Summary will update on new commits.

Review in cubic

@itssimon itssimon self-assigned this Sep 13, 2026

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 108 files

Tip: instead of fixing issues one by one fix them all with cubic

Re-trigger cubic

Comment thread sdk-reference/javascript/v1/setup-guides/elysia.mdx
Comment thread sdk-reference/python/v1/attributes.mdx Outdated
Comment thread style.css
Comment thread sdk-reference/javascript/v1/tracing.mdx
Comment thread sdk-reference/javascript/v1/setup-guides/koa.mdx
Comment thread sdk-reference/python/v1/setup-guides/fastapi.mdx
Comment thread sdk-reference/javascript/v1/attributes.mdx
Comment thread docs.json
Comment thread sdk-reference/javascript/v1/setup-guides/adonisjs.mdx
Comment thread sdk-reference/javascript/v1/masking.mdx

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 7 files (changes from recent commits).

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="sdk-reference/javascript/v1/tracing.mdx">

<violation number="1" location="sdk-reference/javascript/v1/tracing.mdx:69">
P2: When an existing `NodeSDK` uses its `traceExporter` option, this example drops that exporter because the new `spanProcessors` list does not include it. Show the existing exporter wrapped in a span processor in this list, or explain that it must be moved here, so adding Apitally does not silently stop the application's existing trace export.</violation>
</file>

Reply with feedback, questions, or to request a fix.

Fix all with cubic | Re-trigger cubic

Comment thread sdk-reference/javascript/v1/tracing.mdx

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 21 files (changes from recent commits).

Tip: Review your code locally with the cubic CLI to iterate faster.

Fix all with cubic | Re-trigger cubic

Comment thread sdk-reference/python/v1/setup-guides/flask.mdx
Comment thread sdk-reference/javascript/v1/setup-guides/nestjs.mdx

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 20 files (changes from recent commits).

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="sdk-reference/python/v1/configuration.mdx">

<violation number="1" location="sdk-reference/python/v1/configuration.mdx:117">
P3: These callback docs dropped the internal `/sdk-reference/python/v1/attributes` link and point only at generic OpenTelemetry `ReadableSpan` docs. The other v1 pages (`masking.mdx`, `sampling.mdx`) pair the external type link with an explicit `span.attributes` link to the SDK-specific Attributes page, which is what actually documents the attributes these callbacks read. Keep both links.</violation>
</file>

Tip: Review your code locally with the cubic CLI to iterate faster.

Fix all with cubic | Re-trigger cubic

Comment thread sdk-reference/javascript/v1/masking.mdx
Comment thread sdk-reference/python/v1/configuration.mdx

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 3 files (changes from recent commits).

Tip: Review your code locally with the cubic CLI to iterate faster.

Fix all with cubic | Re-trigger cubic

Comment thread sdk-reference/javascript/v1/migration.mdx
Comment thread sdk-reference/python/v1/migration.mdx
@itssimon
itssimon merged commit 9e6329e into main Sep 15, 2026
2 checks passed
@itssimon
itssimon deleted the v1-sdks branch September 15, 2026 09:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant