docs(drift): document slug and properties when creating an organization#797
Open
ekline[bot] wants to merge 1 commit into
Open
docs(drift): document slug and properties when creating an organization#797ekline[bot] wants to merge 1 commit into
ekline[bot] wants to merge 1 commit into
Conversation
ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

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
slug/logo_urladded toCreateOrganization(scalekit-sdk-python #162)slug,external_id,logo_urlwhen creating an org via SDK.slughad zero SDK coverage anywhere.filter_mcp_server_urlfilter onlist_configs(scalekit-sdk-python #164)metadatamap on org create/update (#162)org-redirect-urls.mdxreferences custommetadatatemplate variables but no page shows settingmetadatavia SDK.What this PR covers (gap #1)
The
create-organization.mdxpage documented creating an organization with only adisplay_name. TheCreateOrganizationmessage acceptsslug,external_id, andlogo_url(withslug/logo_urlnewly added in scalekit-sdk-python #162), and other pages already tell users to "setslugon an organization" without showing how. This PR adds:slug,external_id, andlogo_urlat creation.Source
scalekit-sdk-node/src/organization.ts(createOrganization(name, { externalId, logoUrl, slug })) andscalekit-sdk-python/scalekit/v1/organizations/organizations_pb2.pyi(CreateOrganizationfields).Remaining gaps (follow-up)
filter_mcp_server_urlto the AgentKit Python SDKlist_configsreference.metadatavia SDK, complementing the custom template-variable docs inorg-redirect-urls.mdx.How to verify
create-organization.mdxand confirm the new "Set organization properties at creation" section renders with four SDK tabs.scalekit-sdk-node/src/organization.tsand the Python protoCreateOrganizationmessage.📝 Created with EkLine · View session
ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>