Contributing

Updating docs content in source repositories

1. Make documentation changes in the relevant source repository.
2. Commit and push there first.
3. In this repository, bump the submodule pointer:

pnpm docs:pull
git add .gitmodules sources
git commit -m "Update docs submodules"

Adding a new source repository

git submodule add https://github.com/prezly/<repo>.git sources/<repo>
git add .gitmodules sources/<repo>
git commit -m "Add <repo> as docs source"

Then update docs/repositories/index.md and navigation in docs/.vitepress/config.ts.

Regenerating aggregated docs

docs/sources/ is generated and gitignored. Do not edit or commit files there manually.

pnpm docs:sync