docs: three-audience documentation — Use section, builder deep-dives, admin guides#41
Merged
Conversation
New Build-section pages covering the core-feature gaps against the ObjectStack framework docs: relationships, formulas, validation rules; interface landing, apps & navigation, forms, dashboards, custom pages; automation landing, state-machine workflows, and approval processes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0145MY7RdJr8KuRMyn5oKAR6
…management New Configure pages: Administration landing (Setup console tour and task map), Users & Organization (business units, invitations, teams, service accounts), Managing Access (onboarding/offboarding recipes), Field-Level Security, and Connect AI tools via MCP. Sidebar metas updated across all locales. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0145MY7RdJr8KuRMyn5oKAR6
New top-level Use section for everyday users: console tour, working with records, views, dashboards, approvals, notifications, and profile/settings. Content was verified by driving the showcase app's Console in a browser. Landing page gains a three-audience directory (use / build / administer) and the sidebar orders sections by role. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0145MY7RdJr8KuRMyn5oKAR6
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
2 participants
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.
What
Completes the core-feature documentation effort started in #40 by covering all three audiences of the docs site with 26 new English pages:
🧑💼 End users — new top-level
Usesection (7 pages)use/— Using ObjectOS (console tour), Working with records, Using views, Dashboards, Approvals, Notifications, Profile & settings.Every fact was verified by driving the real Console in a browser (showcase example app,
@objectstack/console15.1.1): view-type switcher (Grid/Kanban/Gallery/Calendar/Timeline/Gantt), state pipeline bar, approval inbox tabs (My Pending / I Submitted / Completed / All), notification inbox columns, profile/security surfaces, avatar-menu Theme/Language. Unverified behaviors were deliberately left out.🛠 Builders — Build section deep-dives (14 pages)
build/data/— Relationships, Formulas, Validation Rulesbuild/interface/— section landing, Apps & navigation, Forms, Dashboards, Pagesbuild/automation/— section landing (flow vs workflow vs approval chooser), Workflows (state machines), Approvals🔐 Administrators — Configure expansion (5 pages)
configure/index— Administration landing: Setup console tour + task→doc mapconfigure/users— business units, invitations, teams, service accounts & API keysconfigure/permissions/managing-access— onboard / change role / verify / offboard recipesconfigure/permissions/field-level-securityconfigure/mcp— connect Claude & other AI tools via MCPNavigation
meta.jsonfiles updated across the 7 locales (arrays mirrored; group titles localized; no translation content stubs, per AGENTS.md — locales fall back to English)Fact sources
Builder/admin pages are rewritten for this site from the corresponding ObjectStack framework docs (
objectstack-ai/frameworkcontent/docs/); Use pages from live browser verification. English only — translations follow via the normal sync pass.Verification
npm run type-checkandnpm run buildpass (704 static pages)/docs/build/{data-model,views,actions,flows}still 308-redirect correctly🤖 Generated with Claude Code
https://claude.ai/code/session_0145MY7RdJr8KuRMyn5oKAR6
Generated by Claude Code