mbtorch-docs

To keep documentation synchronized with API changes, you need to update README files, API references, and examples whenever public APIs are added, modified, or removed. This ensures docs remain accurate and aligned with the latest code modifications.

The best way to document breaking changes is to provide Before/After migration sections with copyable code examples. This demonstrates the old behavior versus the new implementation, helping developers understand and adapt to signature modifications quickly.

To generate copyable code examples for technical documentation, you create concise, runnable snippets that demonstrate public API usage. These examples should be placed in the examples directory and updated whenever new examples are added or existing APIs change.

You need to update your README and API reference files when repository-level changes occur, specifically when adding new public APIs, changing function signatures, removing features, or adding new runnable examples to the examples directory.

Doc generation for new public APIs identifies which artifacts require updates and provides consistent style guidance. However, you should review the generated README content, migration templates, and code examples to ensure they accurately reflect complex behavioral changes.

Your API reference shows outdated function signatures because documentation was not updated alongside code modifications. Applying documentation updates to docs pages and README files after signature changes ensures technical references stay accurate and actionable.