Skip to content

Commit 9693307

Browse files
committed
docs(README): Expand SDK documentation with feedback request and upcoming features
- Added a section soliciting user feedback on use cases, feature requests, and documentation suggestions. - Introduced a detailed outline of upcoming features including a template rendering system, Content API support, and a data validation layer. - Updated contribution guidelines to encourage community involvement and adherence to coding standards.
1 parent 6c28b37 commit 9693307

1 file changed

Lines changed: 78 additions & 1 deletion

File tree

README.md

Lines changed: 78 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -550,9 +550,45 @@ if ($nav->hasChildren()) {
550550

551551
The SDK can be easily integrated with Symfony. See the `examples/dotcms-symfony` directory for a complete example.
552552

553+
## We Need Your Feedback!
554+
555+
The SDK is in active development, and your feedback is crucial to its success. We're particularly interested in:
556+
557+
- Use cases and real-world scenarios
558+
- Feature requests and improvements
559+
- Performance feedback
560+
- Integration challenges
561+
- Documentation suggestions
562+
563+
Feel free to:
564+
- Open issues for bugs or feature requests
565+
- Join our community discussions
566+
- Share your implementation experiences
567+
- Suggest improvements to the API design
568+
553569
## Contributing
554570

555-
Contributions are welcome! Please feel free to submit a Pull Request.
571+
We welcome contributions of all kinds! Whether you're fixing bugs, adding features, or improving documentation, your help makes the SDK better for everyone.
572+
573+
### How to Contribute
574+
575+
1. Fork the repository
576+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
577+
3. Make your changes
578+
4. Run the test suite (`composer check`)
579+
5. Commit your changes (`git commit -m 'feat: add amazing feature'`)
580+
6. Push to the branch (`git push origin feature/amazing-feature`)
581+
7. Open a Pull Request
582+
583+
### Pull Requests
584+
585+
We actively review and merge pull requests. To ensure a smooth process:
586+
587+
- Follow our coding standards
588+
- Add tests for new features
589+
- Update documentation
590+
- Use conventional commit messages
591+
- Keep PRs focused and manageable
556592

557593
### Development Setup
558594

@@ -581,6 +617,47 @@ composer phpstan
581617
composer check
582618
```
583619

620+
## What's Next
621+
622+
The SDK is actively being developed with several exciting features planned:
623+
624+
### Template Rendering System
625+
626+
We're working on a comprehensive template rendering system that will make it easier to integrate DotCMS with popular PHP frameworks:
627+
628+
#### Twig Templates
629+
- Pre-built templates for DotCMS layouts, containers, and content types
630+
- Twig extensions for common DotCMS operations
631+
632+
#### Blade Templates
633+
- Ready-to-use Blade components for DotCMS content
634+
- Blade directives for DotCMS-specific functionality
635+
636+
The template system will include:
637+
- Standard layouts for common page structures
638+
- SEO-friendly markup and metadata handling
639+
640+
### Content API Support
641+
- Full Content API integration for content management
642+
- ElasticSearch Support
643+
- Advanced search capabilities
644+
645+
### Data Validation Layer
646+
- Schema-based validation for content types
647+
- Custom validation rules
648+
- Validation error handling
649+
- Type conversion and normalization
650+
- Cross-field validation
651+
- Validation caching
652+
653+
### Additional Features
654+
- Enhanced caching mechanisms
655+
- Additional framework integrations
656+
- Performance optimizations
657+
- Extended documentation and examples
658+
659+
Stay tuned for updates and feel free to contribute to these upcoming features!
660+
584661
## License
585662

586663
This project is licensed under the MIT License - see the LICENSE file for details.

0 commit comments

Comments
 (0)