Skip to content

Document app visibility and show app types on the app page - #327

Merged
wixysam merged 6 commits into
mainfrom
docs/sdk-app-public-settings
Oct 14, 2026
Merged

wixysam merged 6 commits into
mainfrom
docs/sdk-app-public-settings

Conversation

@abrahams-wix

@abrahams-wix abrahams-wix commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

No description provided.

A {@link} to a module method was still pointing at AppModule.mdx after that page was renamed to app.
@github-actions

github-actions Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

🚀 Package Preview Available!


Install this PR's preview build with npm:

npm i @base44-preview/sdk@0.8.53-pr.327.797dbc6

Prefer not to change any import paths? Install using npm alias so your code still imports @base44/sdk:

npm i "@base44/sdk@npm:@base44-preview/sdk@0.8.53-pr.327.797dbc6"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "@base44/sdk": "npm:@base44-preview/sdk@0.8.53-pr.327.797dbc6"
  }
}

Preview published to npm registry — try new features instantly!

Name the link with the JSDoc pipe and drop the file-processing change.
@abrahams-wix abrahams-wix changed the title Keep SDK docs links when module pages are renamed Label the public settings link in JSDoc Oct 13, 2026
- Describe the four visibility values in AppPublicSettings, with a table
  that links to the related product docs, and note that the CLI can't set
  public_with_login.
- Note that SSO enforcement makes public_without_login apps require sign-in.
- Rewrite the app module and getPublicSettings() descriptions, and add a
  redirectToLogin() example for visitors who aren't signed in.
- Expose AppPublicSettings and fold it and AppPublicSettingsResponse into
  the app page under Type Definitions.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@abrahams-wix abrahams-wix changed the title Label the public settings link in JSDoc Document app visibility and show app types on the app page Oct 14, 2026
abrahams-wix and others added 3 commits October 14, 2026 12:30
- Show the public_settings field as AppPublicSettings in the app page's
  Returns section. `| string` makes TypeScript reduce the type to string,
  so the docs pipeline now restores the type name, alongside the existing
  truncated-type cleanup.
- Remove AppPublicSettingsResponse from Type Definitions. The Returns
  section already shows its fields, so the type is deleted after
  processing, like EntityPage. AppPublicSettings stays on the page.
- Move the SSO note from the field into the AppPublicSettings
  documentation and link the field to that section.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Resolve the conflict in file-processing.js. Main moved the type definition
groups from an inline list in groupTypeDefinitions into page-sections.json,
so keep main's version and add the AppPublicSettings group to
typeDefinitionGroups there.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@github-actions github-actions Bot added the docs-draft PR has auto-drafted documentation suggestions label Oct 14, 2026
@wixysam
wixysam merged commit 296e6d1 into main Oct 14, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-draft PR has auto-drafted documentation suggestions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants