Skip to content

Restructure namespace docs #4098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
bechols wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Restructure namespace docs #4098

bechols wants to merge 1 commit into from

Conversation

@bechols
Copy link
Contributor

@bechols bechols commented Jan 5, 2026 •
edited
Loading

What does this PR do?

Restructures namespace documentation into four focused pages:

  • Concepts (encyclopedia/namespaces): Core principles for both open source and Cloud, emphasizing portability
  • OSS Operations (self-hosted-guide/namespaces): Lean how-to guide for open source, linking to detailed CLI/SDK docs. This is the only new page.
  • Cloud Operations (cloud/get-started/namespaces): Existing comprehensive Cloud reference with callout to OSS equivalent
  • Best Practices (best-practices/managing-namespace): Platform-agnostic guidance with Nexus as preferred approach for cross-namespace communication

Notes to reviewers

  • Removed operational content from encyclopedia (moved to self-hosted-guide page) to keep it conceptual
  • Simplified best practices with clear open source vs Cloud labeling
  • Updated Organizational Pattern 3 to highlight Nexus for cross-namespace communication instead of shared namespaces
  • Added callouts on all pages linking between related documentation

Tested locally

@bechols @claude
Restructure namespace documentation for clarity and separation of con…
852efd6 
…cerns

- Create new OSS operations page (self-hosted-guide/namespaces.mdx) with lean how-to guidance
- Simplify encyclopedia page to focus on core concepts only, with callouts explaining portability
- Update best practices page to be platform-agnostic with clear labeling for Cloud vs OSS features
- Add cloud callout to Cloud namespace operations page directing to OSS equivalent
- Restructure with Nexus as preferred approach for cross-namespace communication
- Add organization patterns, naming conventions, and production safeguards

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Haiku 4.5 <[email protected]>
@bechols bechols requested a review from a team as a code owner January 5, 2026 04:01
@vercel
Copy link

vercel bot commented Jan 5, 2026 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
temporal-documentation Ready Ready Preview, Comment Jan 5, 2026 4:02am

@github-actions
Copy link
Contributor

github-actions bot commented Jan 5, 2026

📖 Docs PR preview links

@bechols bechols changed the title Restructure namespace documentation for clarity Restructure namespace docs Jan 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@brianmacdonald-temporal brianmacdonald-temporal

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@bechols @brianmacdonald-temporal