Skip to content

Docs: design for serving multiple projects under one domain by path#13167

Draft
ericholscher wants to merge 1 commit into
mainfrom
claude/nifty-keller-0nfkba-design-domain-by-path
Draft

Docs: design for serving multiple projects under one domain by path#13167
ericholscher wants to merge 1 commit into
mainfrom
claude/nifty-keller-0nfkba-design-domain-by-path

Conversation

@ericholscher

Copy link
Copy Markdown
Member

Why

A customer wants to host many projects under a single path on their own company domain (e.g. https://example.com/docs/<project>/…) but can't point that DNS at us. Today the only way to serve several projects under one domain by path is to model them as subprojects of a parent — which forces customers into a parent/child tree they don't otherwise want.

This adds a design doc proposing the alternative: serve projects under a domain by path without a subproject relationship. It's meant to capture the approach and the open decisions before we commit to an implementation.

What

A new design doc under docs/dev/design/ that covers:

  • the customer scenario (reverse-proxy a path prefix, no DNS delegation)
  • the primitives we already have (custom_prefix, subprojects, X-RTD-Slug / RESOLVE_PROJECT_FROM_HEADER, USE_PROXIED_APIS_WITH_PREFIX)
  • the proposed SERVE_PROJECTS_BY_PATH feature and where it slots into the unresolver (after subprojects, matching the next segment to a project by slug)
  • scoping/security — owner-overlap vs. organization vs. explicit allowlist
  • open questions (mount-prefix knob, explicit modeling, slug collisions)

Related

The doc is deliberately scoped to the design and the decisions, so it's useful even if the prototype in #13140 changes shape.


🤖 Draft generated by Claude Code (AI agent), for review.


Generated by Claude Code

Design proposal for serving multiple projects under a single domain by path
(example.com/docs/<project>/) without modeling them as subprojects, for
customers who reverse-proxy a path prefix to us and can't delegate DNS.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VPEKF2tcrc5DqDLMsdkNUz
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 dev | 🛠️ Build #33397298 | 📁 Comparing 04ed857 against latest (e41c7c3)

  🔍 Preview build  

6 files changed · ± 6 modified

± Modified

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