Changelog¶
All notable changes to the CostEngine (MfgIQ) documentation.
[Unreleased]¶
Documentation¶
- Initial documentation structure created
- Migrated from Word/Excel to MkDocs
- Added Mermaid diagrams for workflows
- Enhanced content with Material for MkDocs features
[1.0.0] - 2026-01-24¶
Added¶
- Domain Logic Specification v2.0
- Complete cost component hierarchy
- Material cost formulas
- Routing & operations engine
- Scrap & yield logic
-
Explainability framework
-
MVP Scope v1.0
- Core user flow definition
- Must-have features list
- Screen specifications (12 screens)
-
Success criteria
-
Data Formats
- CostingFormat2 (XLSX) template
-
Import/export specifications
-
Product Branding
- Rebranded as "CostEngine (MfgIQ)"
- Professional documentation theme
- Custom styling matching industry standards
Documentation¶
- Created comprehensive homepage
- Added strategic foundation overview
- Structured navigation with clear categories
- Implemented search functionality
- Dark/light mode support
Documentation Version History¶
v2.0 (Current)¶
- Date: 2026-01-24
- Changes: Complete redesign with MkDocs Material theme
- Status: Yes Production-ready
v1.0 (Legacy)¶
- Date: 2025-2026
- Format: Word documents (.docx)
- Status: Warning Archived in
customer-docs/
Upcoming Changes¶
Planned for Next Release¶
- Add API documentation
- Include screenshot walkthroughs
- Add deployment guide
- Create user onboarding tutorials
- Add troubleshooting section
Under Consideration¶
- Video demonstrations
- Interactive cost calculator examples
- ROI calculator tool
- Customer case studies
For product roadmap and feature development, see MVP Scope