rspress-sync

To keep documentation in sync with API changes, this Skill reads design.config.json to locate docs, detects API changes by comparing timestamps, and updates cross-references, code examples, and migration notes while preserving custom content.

The best way to update cross-references and code examples across modules is to run an automated synchronization process. It detects API changes by comparing timestamps and automatically aligns user-facing site docs with the latest generated API documentation across all project modules.

Yes, you can preserve custom content when migrating breaking changes into user docs. The synchronization process inserts migration notes for breaking changes while safely retaining your existing custom documentation, and it generates a sync report to ensure audit-ready updates.

Automated API documentation synchronization handles breaking changes by detecting updates through timestamp comparisons and automatically inserting migration notes into the site documentation. It ensures breaking changes are clearly documented while keeping cross-references and code examples current.

Yes, you need a design.config.json file to automate alignment of API and user docs. The synchronization process reads this configuration file to locate your documentation directories and identify which modules require updates based on detected API changes.