Skip to content

docs: document session sharing (AGE-2577) - #1306

Open
hary73 wants to merge 3 commits into
mainfrom
haryahuja/age-2577-session-sharing-docs
Open

hary73 wants to merge 3 commits into
mainfrom
haryahuja/age-2577-session-sharing-docs

Conversation

@hary73

@hary73 hary73 commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Documents session sharing (AGE-2577), added in #1122 and #1123, on the Sessions page of trueforge.dev.

Changes

  • New "Sharing a session" section in docs/sessions.mdx:
    • Share from the UI: how to add people, the General access choice (Restricted or Everyone within the tenant), and the Share URL.
    • What people you share with can do: a read-only view, and what they can't do. Shared sessions don't appear in their sessions list, and removing access takes effect immediately.
    • Availability note: sharing with specific people needs a user directory (TrueFoundry platform). Local mode and OIDC login share with the whole tenant only.
    • Share from the SDK: a TypeScript and Python example for granting and revoking, with links to the generated API Reference (list and update grants, list users) and the session_sharing.granularity capability.
  • Updated the owner-scoped history note to point to sharing.

How was this tested?

  • npx mint broken-links in docs/: no broken links. This also confirms the MDX parses.
  • Prettier passes on docs/sessions.mdx.
  • I checked the SDK method names and field casing against the generated TypeScript and Python SDKs.

Checklist

  • I have read the contributing guidelines
  • pnpm build, pnpm test, pnpm typecheck, pnpm lint:ci, and pnpm format:check pass locally
  • Tests added/updated where it makes sense
  • No hand-edits to generated code (packages/trueforge-sdk, python/trueforge_sdk, .github/fern/openapi/openapi.json, docs/openapi.json) — fork PRs omit SDK regen; maintainers regenerate after merge
  • Docs / .env.example updated if configuration or behavior changed

Note

Low Risk
Documentation-only changes to the Sessions MDX; no runtime or API behavior changes.

Overview
Extends the Sessions page to cover read-only session sharing: how creators share from the UI (add people, Restricted vs Everyone within tenant, copy Share URL), what recipients can and cannot do, and when per-user vs tenant-only sharing applies (user directory on TrueFoundry; local/OIDC limits).

The owner-scoped history note now says shared sessions open from their share link rather than appearing in someone else’s list.

Adds Share from the SDK with TypeScript and Python examples for grant/revoke via updateGrants, links to list/update grants and list users APIs, and documents that only the creator can manage grants and that session_sharing.granularity reflects subject vs tenant sharing availability.

Reviewed by Cursor Bugbot for commit 578cdf2. Bugbot is set up for automated code reviews on this repo. Configure here.

Co-authored-by: Cursor <cursoragent@cursor.com>
@changeset-bot

changeset-bot Bot commented Nov 6, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 578cdf2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

…2577)

Co-authored-by: Cursor <cursoragent@cursor.com>
@hary73
hary73 marked this pull request as ready for review November 6, 2026 12:27
@qodex-ai

qodex-ai Bot commented Nov 6, 2026 •

Copy link
Copy Markdown

Qodex review

Reviewed units u1. The history note now distinguishes session lists from shared links.

Effort: ●●●○○ (3/5) · No findings worth raising. The diff reads clean.

Scope: the whole pull request (no previous review: the whole change is reviewed).

Walkthrough

Notes

  • Code around the change is partial: 12 symbols cut at the packet byte cap.
What Qodex checked

Lenses (openqodex review with checked answers, all dimensions)

  • Bugs and correctness
  • Security (auth, injection, SSRF, secrets, headers)
  • Performance regressions
  • Maintainability
  • Style and consistency

Scanners

  • actionlint did not run
  • bandit did not run
  • brakeman did not run
  • cargo-deny did not run
  • checkov did not run
  • gitleaks 8.21.2
  • golangci did not run
  • hadolint did not run
  • kube-linter did not run
  • kubeconform did not run
  • osv-scanner 2.6.0
  • oxlint did not run
  • rubocop did not run
  • ruff did not run
  • semgrep 1.94.0
  • shellcheck did not run
  • sqlfluff did not run
  • sqllint did not run
  • squawk did not run
  • tflint did not run
  • trivy did not run
  • zizmor did not run
  • 0 scanner candidates raised or dropped by the reviewer

Quality filters

  • PR description: complete (length, checklist, issue link)
  • Repo card last refreshed 8 days ago — may not reflect very recent code structure changes
  • Per-category confidence floor (bug/security/performance 0.7, maintainability 0.71, style 0.75)
  • Severity threshold from .qodex.yaml: minor
  • Path excludes (none configured in .qodex.yaml)
  • Disabled rules (none configured in .qodex.yaml)

Verification (M1b probes against PR preview)

  • Preview deployment discovered (no successful deploy for this commit)
  • Probes (skipped, no preview to probe)

Cross-review dedup

  • Full review: no previous review: the whole change is reviewed
  • Carry-overs (no findings from earlier reviews still present)

Output

  • Walkthrough comment posted
  • Inline comments (no in-diff findings to attach)

Reviewer: shown 2 of 2 changed hunks, opened 7 files, 28 tool calls served, 17 model calls, 0 correction rounds, 68.9s. The library does not report tool calls asked apart from those it served, or a step cap.
Reviewed by Qodex · 89.5s

Every dimension is reviewed. Bugs, security, and performance post inline; low-severity style and convention notes are collected in the group above rather than dropped. Mark a finding resolved or flag a false positive in the Qodex Pull Requests view.

This branch has not been deployed

No deployments
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