Skip to content

chore(docs): align Outpost tenant terminology with dashboard onboarding#858

Merged
leggetter merged 6 commits intomainfrom
chore/docs-terminology-onboarding-feedback
Apr 22, 2026
Merged

chore(docs): align Outpost tenant terminology with dashboard onboarding#858
leggetter merged 6 commits intomainfrom
chore/docs-terminology-onboarding-feedback

Conversation

@leggetter
Copy link
Copy Markdown
Collaborator

Summary

Doc-only updates so public Outpost docs describe tenants the same way as the refreshed Hookdeck dashboard onboarding copy: entities in the host product (organization, project, workspace, team, or user), with customer account called out lightly where it helps SaaS readers without repeating it everywhere.

Changes

  • docs/content/concepts.mdoc — Typical flow + Tenants model + tenant ID examples; optional parenthetical tying “account” to the same layer when products use that word.
  • docs/content/guides/building-your-own-ui.mdoc — Tenant context bullet: UI scope as customer account in the broad sense, then concrete examples.
  • docs/content/features/multi-tenancy.mdoc — Tenant identifier examples expanded to match (org / project / workspace / team / user IDs, etc.).

No API or runtime changes.

Made with Cursor

Clarify how tenants map to orgs, workspaces, and end users; spell out
stable tenant IDs from the host product; and disambiguate Outpost tenants
from Hookdeck accounts. Refresh the BYUI guide tenant context to match the
same vocabulary used in the dashboard copy (Maurice onboarding session).

Made-with: Cursor
Clarify that tenant ids can align to organizations, projects, workspaces,
teams, or users; mention customer account where it helps without repeating
everywhere. Touch concepts, BYUI tenant context, and multi-tenancy identifiers.

Made-with: Cursor
Copilot AI review requested due to automatic review settings April 21, 2026 19:51
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates Outpost documentation to align “tenant” terminology with the refreshed Hookdeck dashboard onboarding language, clarifying that an Outpost tenant maps to an entity in the host product (org/project/workspace/team/user).

Changes:

  • Refines the “tenant” model explanation and typical flow in Concepts.
  • Clarifies tenant context guidance for teams building their own UI.
  • Expands tenant identifier examples in the multi-tenancy feature doc.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
docs/content/concepts.mdoc Reframes tenant mapping to be explicitly tied to a host-product entity and expands identifier examples.
docs/content/guides/building-your-own-ui.mdoc Updates “Tenant context” bullets to describe UI scope and how to resolve it to tenant_id.
docs/content/features/multi-tenancy.mdoc Broadens tenant identifier examples to include org/project/workspace/team/user IDs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/content/concepts.mdoc Outdated
Comment thread docs/content/concepts.mdoc Outdated
Comment thread docs/content/concepts.mdoc Outdated
Comment thread docs/content/features/multi-tenancy.mdoc Outdated
leggetter and others added 4 commits April 21, 2026 21:50
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Attach docs/agent-evaluation/results/runs after the job (if: always) so
failed heuristic/LLM or live Outpost steps retain transcripts and scores
for debugging without relying on runner logs alone.

Made-with: Cursor
Use actions/checkout@v5 and actions/setup-node@v6 so action JavaScript
runs on Node 24 per runner defaults. Set eval and portal release builds
to Node 24; upgrade upload-artifact to v7 in docs agent eval workflow.

Made-with: Cursor
Document Turn 0 assembly (shared template plus 01-only appendix) in AGENTS
and README; fix prompt links to hookdeck-outpost-agent-prompt.md.

Harness extracts <!-- eval:turn0-appendix-start/end --> from 01-basics-curl.md
and appends after the filled template; dry-run logs appendix size when 01 is
selected.

Made-with: Cursor
@leggetter leggetter merged commit 0be42fc into main Apr 22, 2026
2 checks passed
@leggetter leggetter deleted the chore/docs-terminology-onboarding-feedback branch April 22, 2026 17:59
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.

2 participants