-
Notifications
You must be signed in to change notification settings - Fork 4
Document self-hosted base path configuration #2251
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.
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
base: main
Are you sure you want to change the base?
Conversation
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
| Your documentation will be available at `localhost:<port-number>/docs`. | ||
|
|
||
| <Warning> | ||
| The base path must start with a forward slash and should not end with one. For example, use `/docs` not `docs` or `/docs/`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'shouldn't' instead of 'should not'.
|
look at who made the PR to fern-platform which inspired this PR. make that person the assignee for this PR. |
|
Assigned @coltondotio who created the original fern-platform PR #5393 that added this feature. |
|
This PR is stale because it has been open 25 days with no activity. Remove stale label or comment or this will be closed in 5 days. |
Document self-hosted base path configuration
Summary
Adds documentation for the
NEXT_PUBLIC_BASE_PATHenvironment variable that allows self-hosted deployments to serve documentation from a subpath (e.g.,https://example.com/docsinstead ofhttps://example.com).This feature was added in fern-platform PR #5393 but was not documented in the user-facing setup guide. The documentation includes:
Review & Testing Checklist for Human
NEXT_PUBLIC_BASE_PATHis the correct variable name for runtime configuration (I based this on code review of fern-platform PR #5393)Test Plan
docker run -p 3000:3000 -e NEXT_PUBLIC_BASE_PATH=/docs <image>http://localhost:3000/docshttp://localhost:3000/Notes