Skip to content

Docs Source And Sync

Capell docs are assembled from the docs shell in capell-app/capell-docs and public Markdown from the source repositories checked out under _sources/ during sync.

The package shelf and package pages are generated from package manifests and public docs in capell-4/packages, published from the capell-app/packages repository.

SourceLocal sync pathPublic docs copied
capell-app/capell_sources/coredocs/; packages/**/README.md and packages/**/docs/**
capell-app/packages_sources/packagesdocs/; packages/**/README.md and packages/**/docs/**

Use local sync when working against sibling checkouts of capell-4 and capell-4/packages:

Terminal window
npm run sync:local

Use source-specific syncs when you only need one side refreshed:

Terminal window
npm run sync:local:core
Terminal window
npm run sync:local:packages

The sync intentionally excludes internal, specs, and superpowers directories at every docs level before content reaches the public site.