Bilingual documentation for microsphere-dynamic, the Microsphere project that provides dynamic, per-module JDBC auto-configuration for Spring Boot (data sources, ShardingSphere, MyBatis, MyBatis-Plus, transactions).
- English is the default language. Chinese content lives in a parallel
zh/directory beside every document, with identical file names. - Documentation analyses release branches only. One subdirectory per branch line:
currentforrelease,1.xforrelease-1.x.
Current state of this repository: no
releaseorrelease-1.xbranch exists yet and there are no tags. Only thecurrentline is published, generated frommain(revision0.0.1-SNAPSHOT). The1.xdirectory will appear once arelease-1.xbranch exists.
| Line | Source branch | Status | User Guide | Developer Guide |
|---|---|---|---|---|
current |
main (stands in for release, which does not exist yet) |
Published (EN + 中文) | current/user-guide/README.md | current/developer-guide/README.md |
1.x |
release-1.x |
Not applicable — branch does not exist | — | — |
- User Guide — API explanations, code examples taken from the project's own test cases, version information, and the compatibility range, one document per Maven module.
- Developer Guide — architecture design, source analysis, design patterns, Mermaid flow/sequence diagrams for complex flows, and module dependency diagrams, one document per Maven module.
| Module | Packaging | User Guide | Developer Guide |
|---|---|---|---|
microsphere-dynamic-jdbc-spring-boot |
JAR | user-guide | developer-guide |
microsphere-dynamic-parent |
POM | user-guide | developer-guide |
microsphere-dynamic-dependencies |
POM (BOM) | user-guide | developer-guide |
中文文档入口：zh/README.md