Documentation should provide comprehensive detail that enables users to understand impacts and developers to understand implementation. For breaking changes, include migration guidance, deprecated features, and specific functional changes. For technical documentation, provide granular step-by-step explanations that trace execution flow.
Documentation should provide comprehensive detail that enables users to understand impacts and developers to understand implementation. For breaking changes, include migration guidance, deprecated features, and specific functional changes. For technical documentation, provide granular step-by-step explanations that trace execution flow.
For breaking changes in changelogs:
For developer guides:
Example from changelog:
## 0.16.0
### Breaking Changes
* **Remove ingest implementation**
- Migration: Use new unstructured-ingest library (link to installation guide)
- Deprecated extras: s3, local-inference, github (see migration guide)
- Removed submodules: unstructured.ingest.v1.*, unstructured.ingest.connectors.*
- Related: embed submodule updated with SecretStr for secret handling
Enter the URL of a public GitHub repository