Skip to content

docs(drift): document slug and properties when creating an organization#797

Open
ekline[bot] wants to merge 1 commit into
mainfrom
docs/drift/org-create-properties
Open

docs(drift): document slug and properties when creating an organization#797
ekline[bot] wants to merge 1 commit into
mainfrom
docs/drift/org-create-properties

Conversation

@ekline

@ekline ekline Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Context

This PR addresses documentation drift identified by reviewing the last 30 days of code changes across the Scalekit source repos (CLI, SDKs, authstack).

Top 3 gaps found

Rank Priority Change Type Doc status What users need
1 High slug/logo_url added to CreateOrganization (scalekit-sdk-python #162) New configuration Incomplete How to set slug, external_id, logo_url when creating an org via SDK. slug had zero SDK coverage anywhere.
2 Medium filter_mcp_server_url filter on list_configs (scalekit-sdk-python #164) New configuration Missing The new MCP filter param isn't listed on the AgentKit Python SDK reference.
3 Medium metadata map on org create/update (#162) New configuration Incomplete org-redirect-urls.mdx references custom metadata template variables but no page shows setting metadata via SDK.

What this PR covers (gap #1)

The create-organization.mdx page documented creating an organization with only a display_name. The CreateOrganization message accepts slug, external_id, and logo_url (with slug/logo_url newly added in scalekit-sdk-python #162), and other pages already tell users to "set slug on an organization" without showing how. This PR adds:

  • A "Set organization properties at creation" subsection with a parameter table.
  • Four-language SDK examples (Node.js, Python, Go, Java) showing slug, external_id, and logo_url at creation.
  • Cross-links to the template redirect URLs and organization branding guides.

Source

  • scalekit-sdk-python Hides the page sidebar actions in mobile and tab layouts #162 — feat: regenerate protos from v0.1.123.0 and add slug/logo_url to CreateOrganizationOptions
  • Verified against SDK source: scalekit-sdk-node/src/organization.ts (createOrganization(name, { externalId, logoUrl, slug })) and scalekit-sdk-python/scalekit/v1/organizations/organizations_pb2.pyi (CreateOrganization fields).

Remaining gaps (follow-up)

  • Code-expressive #2: Add filter_mcp_server_url to the AgentKit Python SDK list_configs reference.
  • Styles #3: Show setting organization metadata via SDK, complementing the custom template-variable docs in org-redirect-urls.mdx.

How to verify

  • Open the preview link for create-organization.mdx and confirm the new "Set organization properties at creation" section renders with four SDK tabs.
  • Cross-check the field names against scalekit-sdk-node/src/organization.ts and the Python proto CreateOrganization message.

Note: Go/Java SDK repos are not in this workspace; their field names (Slug, ExternalId, LogoUrl / .setSlug, .setExternalId, .setLogoUrl) follow the proto and the existing organization-branding.mdx convention.


📝 Created with EkLine · View session

ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>

ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>
@netlify

netlify Bot commented Jun 26, 2026

Copy link
Copy Markdown

Deploy Preview for scalekit-starlight ready!

Name Link
🔨 Latest commit da61e7c
🔍 Latest deploy log https://app.netlify.com/projects/scalekit-starlight/deploys/6a3edc5bde5e3800087a6efb
😎 Deploy Preview https://deploy-preview-797--scalekit-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 49 (🟢 up 8 from production)
Accessibility: 98 (no change from production)
Best Practices: 92 (no change from production)
SEO: 92 (no change from production)
PWA: -
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@saif-at-scalekit

Copy link
Copy Markdown
Collaborator

This change needs to be applied in the API reference file that's generated at its source. The current approach to update an .mdx file is not scalable. Parking this, until a new PR is linked and addressed at its source.

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