TaipanStack v0.3.2 — Documentation & Quality Release¶
Overview¶
v0.3.2 is a patch release focused heavily on advancing the project's documentation accessibility and presentation, along with performance pipeline stability. It introduces a brand new MkDocs Material documentation portal, fixes crucial accessibility issues, and stabilizes the benchmark CI threshold.
1. MkDocs Material Documentation Portal¶
Files:
- mkdocs.yml
- docs/architecture.md
- docs/api/*.md
TaipanStack now utilizes a first-class documentation portal built with MkDocs Material. The portal integrates all system architecture documentation and API references into a highly readable, searchable, and navigable interface.
What Changed¶
- Navigation tree grouping Core, Config, Security, and Utility APIs.
- Built-in site-search, dark mode toggling, and code-copying functionality.
- Direct links to GitHub repositories and PyPI package instances directly from the docs.
2. Accessibility & Standards Fixes¶
Files:
- docs/* generated outputs and templates
We ensured that our newly generated documentation portal meets rigorous web accessibility standards.
What Changed¶
- Form Labels: Replaced missing or duplicate discernible text and fixed
<form>elements lacking explicit labels. - Safari Support: Addressed and replaced legacy Safari-specific
autocapitalizeattributes that threw warnings. - Axe-Core Warnings: Cleared out HTML accessibility warnings detected by linters and IDE plugins.
3. Security Hardening in Documentation¶
Files:
- Various docstrings in src/taipanstack/security/*
Addressed potential vulnerabilities within the generated HTML of the documentation itself.
What Changed¶
- XSS Prevention: Fixed potential Cross-Site Scripting (XSS) vectors that could theoretically occur if raw security docstrings were unsafely rendered into the MkDocs HTML output.
4. CI Benchmark Threshold Stabilization¶
Files:
- .github/workflows/benchmarks.yml
Our property-based testing and benchmark actions have been fine-tuned to reduce false positives in Continuous Integration environments.
What Changed¶
- Threshold Increased: Raised the performance regression threshold up to 150% (up from earlier overly strict boundaries) in the
benchmark-actionworkflow to account for natural CI runner variance. This prevents transient test failures on GitHub-hosted runners.
5. Type Annotation Alignments¶
Files:
- src/taipanstack/security/guards.py (and related pattern definitions)
What Changed¶
- Fixed type annotation structures for
_TRAVERSAL_PATTERNSto explicitly align withpyright --strictmode definitions, ensuring that the type checker correctly understands the compiled regex sequence tuple.
Quality Summary¶
| Metric | v0.3.1 | v0.3.2 |
|---|---|---|
| Documentation Portal | ❌ (Raw MD) | ✅ (MkDocs) |
| Accessibility Warnings | >0 | 0 |
| Strict Type Violations | 1 | 0 |
| Breaking changes | 0 | 0 |