Skip to content

Commit 4e78d48

Browse files
committed
Documentation: Updates documentation site content
Enhances the documentation site with new pages, improved structure, and detailed guides. Adds filtering capabilities to SFCC class info tool, interactive AI response comparison modals, and improved test coverage. Aligns project licensing to MIT and enhances CI/CD pipeline with improved linting and security checks. Fixes URL fragment handling and improves argument validation for log analysis tools.
1 parent 4d1b041 commit 4e78d48

File tree

1 file changed

+34
-8
lines changed

1 file changed

+34
-8
lines changed

CHANGELOG.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,50 @@ Release comparison links are provided at the bottom. Earlier patch releases on t
88

99
## [1.0.14] - 2025-09-16
1010
### Added
11-
- Documentation site: examples page, tools page, features page, configuration documentation page (progressive enhancement of React/Vite docs site).
11+
- **SFCC Class Information Filtering**: Enhanced `get_sfcc_class_info` tool with comprehensive filtering capabilities including search parameter, inclusion/exclusion of descriptions, constants, properties, methods, and inheritance hierarchy.
12+
- **AI Response Comparison Modals**: Interactive modals on documentation site showing side-by-side comparison of AI responses with and without MCP server, including zoom functionality for detailed inspection.
13+
- **Documentation Site Enhancements**:
14+
- Examples page with practical usage scenarios and filtering demonstrations
15+
- Tools page documenting all available MCP tools
16+
- Features page highlighting key capabilities
17+
- Configuration documentation page with setup instructions
18+
- AI Instruction Files section for different AI platforms
19+
- LLMs documentation file for AI assistant integration
20+
- Troubleshooting page for common issues
21+
- Development and security documentation pages
22+
- **Homepage Value Proposition**: Enhanced homepage with clear value proposition and practical examples.
23+
- **Anchor Link Navigation**: Added IDs to documentation headers for direct linking.
1224

1325
### Changed
14-
- Project licensing aligned to MIT: replaced ISC LICENSE text with MIT License; updated `package.json` license field.
15-
- UI/Docs polish: padding/layout adjustments, site structure updates, simplified deployment workflow.
26+
- **Project Licensing**: Aligned to MIT License (replaced ISC LICENSE text, updated `package.json` license field).
27+
- **CI/CD Pipeline**: Enhanced with improved linting and security checks.
28+
- **Documentation Structure**: Comprehensive reorganization and expansion of documentation site structure.
29+
- **Code Examples**: Updated with full path references for better clarity.
30+
- **Configuration Examples**: Updated example configurations for better usability.
31+
- **UI/UX Polish**: Improved padding, layout adjustments, and site navigation structure.
1632

1733
### Fixed
18-
- Workflow path correction for page deployment.
19-
- Improved log tool argument validation robustness.
34+
- **URL Fragment Handling**: Fixed URL-encoded hash fragment handling in documentation site.
35+
- **Workflow Deployment**: Corrected path issues for page deployment.
36+
- **Log Tool Validation**: Improved argument validation robustness for log analysis tools.
2037

2138
### Documentation
22-
- AI interface setup guide updates; refined documentation site structure; removed obsolete legacy docs site; clarified deployment and navigation.
39+
- **AI Interface Setup**: Comprehensive guides for Claude Desktop, Cursor, and GitHub Copilot integration.
40+
- **Security Guidance**: Enhanced security considerations and best practices documentation.
41+
- **Troubleshooting**: Added comprehensive troubleshooting guide for common setup and usage issues.
42+
- **Development Workflow**: Detailed development guidelines and contribution instructions.
2343

2444
### Testing
25-
- Added / enhanced job execution summary tests; job log tests (entries, search, summary); improved test setup reliability.
45+
- **Enhanced Test Coverage**:
46+
- Comprehensive programmatic tests for SFCC class info filtering in documentation mode
47+
- Enhanced YAML-based MCP tests for class information tools
48+
- Job execution summary tests and job log analysis tests
49+
- Improved test setup reliability and CI stability
2650

2751
### Notes
28-
- Consider CI guard to ensure LICENSE, badge, and package metadata remain consistent.
52+
- Major documentation site expansion with React/Vite architecture
53+
- Enhanced developer experience with comprehensive filtering and search capabilities
54+
- Improved AI assistant integration with detailed setup guides for multiple platforms
2955

3056
## [1.0.13] - 2025-09-15
3157
### Added

0 commit comments

Comments
 (0)