Skip to content

docs: prefer docs.yml subpath for self-hosted base path#6221

Open
devin-ai-integration[bot] wants to merge 3 commits into
mainfrom
devin/1783968492-self-hosted-base-path
Open

docs: prefer docs.yml subpath for self-hosted base path#6221
devin-ai-integration[bot] wants to merge 3 commits into
mainfrom
devin/1783968492-self-hosted-base-path

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

Reworks the "Base path" section of the self-hosted setup docs to reflect that Fern now infers the base path from the docs.yml instance subpath, so NEXT_PUBLIC_BASE_PATH is no longer required.

  • Primary/recommended approach is now defining the subpath on the instance url + custom-domain in docs.yml:
    instances:
      - url: plantstore.docs.buildwithfern.com/docs
        custom-domain: docs.plantstore.dev/docs
    Notes that fern generate --docs validates url and custom-domain share the same base path, so the subpath goes on both or neither.
  • NEXT_PUBLIC_BASE_PATH is now documented as an override that takes precedence over the docs.yml subpath, retaining the build-time (readOnlyRootFilesystem-compatible) vs runtime patching tradeoffs under <Tabs>.
  • Updates the env-var table row for NEXT_PUBLIC_BASE_PATH to describe it as an override and sets its default to "Inferred from docs.yml subpath (else serves from /)".

Cross-reference sweep: NEXT_PUBLIC_BASE_PATH and the env-var-only base path behavior only appear on this page; the domain/multi-source pages already describe the docs.yml url/custom-domain subpath mechanism (cloud-hosted, reverse-proxy based), so no additional pointers were warranted.

Validated with pre-commit (0 Vale errors) and fern check --warnings (0 errors).

Link to Devin session: https://app.devin.ai/sessions/7772aa172d854e61b7ff24189a239940

Co-Authored-By: ryanstep <ryanstep@umich.edu>
@devin-ai-integration devin-ai-integration Bot requested a review from devalog as a code owner July 13, 2026 18:48
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://fern-preview-devin-1783968492-self-hosted-base-path.docs.buildwithfern.com/learn

Here are the markdown pages you've updated:

devin-ai-integration Bot and others added 2 commits July 13, 2026 18:56
… reuse

Co-Authored-By: ryanstep <ryanstep@umich.edu>

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Claude Code Review

Claude Code Review is paused for this repository. To reconnect it, an admin of this repository's GitHub organization (or the account owner, for personal repositories) who can also manage your Claude organization's Code Review settings needs to re-link GitHub in Code Review settings. This is a one-time step.

Tip: disable this comment in your organization's Code Review settings.

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.

0 participants