Major Version Update
This commit delivers a major documentation and developer-experience refresh across the project, with a focus on consistency, maintainability, and onboarding clarity.
Summary of changes:
- Reworked project documentation structure to align with MkDocs expectations.
- Corrected and stabilized site navigation so docs pages resolve cleanly.
- Updated theme configuration for broader compatibility and reliable local docs serving.
- Added and refined cross-page documentation links to improve discoverability.
- Removed/adjusted invalid or external doc references that caused strict build warnings.
- Expanded feature coverage in docs to better reflect current framework capabilities.
- Added dedicated example pages under docs for easier guided exploration.
- Improved README content to be concise while preserving essential information.
- Added contribution guidelines to standardize community contribution workflow.
- Ensured license visibility in top-level documentation and repository metadata.
Documentation improvements:
- Organized docs into clearer sections (core, features, extension, testing, examples).
- Ensured each major feature area has a dedicated reference page.
- Added “See Also” style relationships between related topics for smoother navigation.
- Updated examples documentation to map practical use-cases to framework concepts.
- Tightened wording and formatting for readability and reduced duplication.
Developer experience improvements:
- Ensured MkDocs strict-mode builds pass after link and nav cleanup.
- Improved compatibility when Material theme is unavailable by supporting built-in theme configuration.
- Reduced setup friction for local contributors by documenting expected workflow.
Repository health and governance:
- Added CONTRIBUTING guidelines with setup, test, and PR expectations.
- Reinforced licensing clarity by explicitly referencing MIT licensing in documentation.
- Standardized top-level project messaging to match current framework direction.
Why this is a major version update:
- This update materially improves first-time onboarding, documentation trustworthiness, and project maintainability.
- It introduces a stronger documentation contract and contributor workflow expectations.
- The scope spans multiple foundational project surfaces (docs architecture, README, contribution process, and documentation build behavior), making it a major release-level change in developer-facing experience.
Notes:
- No runtime feature removals are introduced in this commit.
- Primary impact is on documentation quality, structure, and contributor enablement.
Full Changelog: 1.0.6...2.0.0