GPDoc is offline-first by design. Follow these steps to configure a workspace that operates without constant connectivity.
Prerequisites
- GPDoc desktop app or CLI installed on each contributor’s machine.
- Access to your organization’s Git remote (even if sync is delayed).
- Local encryption policy defined by your security team.
Setup checklist
- Create a workspace using
gpdoc initand select the offline-first profile. - Disable auto-sync by setting
sync.mode = manualinworkspace.config.json. - Define storage paths so sensitive docs live on encrypted drives.
- Cache runtimes with
gpdoc runtimes preloadfor Python, TypeScript, and SQL. - Share templates via the workspace repository so everyone starts from the same component library.
Working offline
- Draft documents, notebooks, and slides as usual. GPDoc queues commits locally.
- Use
gpdoc reviewto simulate pull requests and collect feedback in person or over secure channels. - Export HTML or PDF bundles for stakeholders who cannot access the workspace directly.
Syncing on your schedule
When the security team opens a sync window:
# review queued commits
gpdoc sync status
# push to the remote when approved
gpdoc sync pushResolve conflicts locally. GPDoc surfaces component-level diffs, so merges stay manageable even after long offline stretches.
Remember
Keep an offline copy of your automation scripts so exports and lint checks stay available without a network connection.
That is enough to keep local work moving while preserving the option to publish when the time is right.
Next guide
Publish GPDoc hubs to your custom domain
Map Netlify, Vercel, or CDN hosting so your docs look and feel like the rest of your product.