Implement only the infrastructure required to host both doc generations.
Tasks:
- add the second Docusaurus docs plugin
- add
content/en/docs-next - add
sidebars-next.js - expose
/docs-next - verify
/docsremains unchanged - verify production build succeeds
- verify current localization scripts still work
- resolve any plugin ID or generated-route conflicts
Do not start the large content migration until this foundation works.
Create:
- the full
/docs-nextsidebar - category landing pages
- final slug conventions
- directory structure
- initial old-to-new URL mapping artifact
The full navigation should now be visible even if some pages are initially skeletal.
Implement:
- Getting Started
- Installation
- Fundamentals
- Production Checklist
This phase must include an end-to-end review of Getting Started.
A new user should be able to install CapRover and deploy an HTTPS application using that workflow alone.
Create the two core product sections.
Break apart relevant old docs such as:
-
app-configuration.md -
deployment-methods.md -
captain-definition-file.md -
CLI docs
-
CI/CD docs
-
registry content
-
Add missing code-backed application settings where appropriate.
Cover:
-
root domain
-
DNS
-
HTTPS
-
certificates
-
NGINX
-
internal networking
-
public ports
-
firewall
-
databases
-
persistent directories
-
volumes
-
shared storage
-
data backup
-
Validate workflows that cross multiple features, especially external database access.
Create:
-
scaling
-
health checks
-
zero-downtime deployment
-
complete multi-node workflow
-
node management
-
One-Click Apps product area
-
Validate the multi-node flow against current backend requirements.
Create:
-
server settings
-
upgrades
-
CapRover backup/restore
-
server migration
-
NetData
-
GoAccess
-
cleanup
-
security
-
Pro
-
themes
-
diagnostics
-
uninstall
-
Validate backup/restore semantics against current code.
- Move recipe-style content into Guides.
- Distribute troubleshooting content into the product areas that own each failure mode.
- Create the small top-level troubleshooting router.
Create code-backed reference material for:
-
Captain Definition
-
app configuration
-
CLI
-
API/client
-
server environment variables
-
config overrides
-
ports
-
Docker Compose
-
One-Click schema
-
backups
-
defaults and limits
-
glossary
-
compatibility
-
Verify reference values against source code.
Before any cutover:
- review the entire sidebar
- review every major task path
- review the old-to-new URL mapping
- fix missing content
- fix incorrect categorization
- run production build
- validate navigation and links
- confirm old
/docsremains unaffected
Stop here until explicit approval to cut over.