Documentation Release Workflow

Keep docs synchronized with every new product version.

Documentation is a release artifact of Instant Language Switcher, not a separate afterthought.

Version-sync rule

Whenever the Instant Language Switcher product version changes, update the documentation in the same release cycle before moving on to further development.

The documentation release should include:

1. updated Markdown source
2. regenerated static documentation site
3. updated search index/navigation
4. updated changelog/version references
5. updated WordPress documentation plugin
6. updated downloadable documentation ZIPs

Project automation

The documentation project contains:

build.py
sync_release.py
pages.json
source/
site/

build.py regenerates the complete static site from Markdown source and pages.json.

sync_release.py can read an Instant Language Switcher release ZIP, detect the plugin version, update the documentation version configuration, import the release changelog section when available, regenerate the site and prepare the project for packaging.

Example:

python sync_release.py /path/to/instant-language-switcher-v0.21.0.zip
python build.py

The human release review must still document behavioral changes that cannot be inferred automatically from the ZIP/changelog.

Current pairing