Skip to content

docs: update docs with enhanced features and usage …#90

Merged
soulteary merged 4 commits intomainfrom
docs-guide
Jan 7, 2026
Merged

docs: update docs with enhanced features and usage …#90
soulteary merged 4 commits intomainfrom
docs-guide

Conversation

@soulteary
Copy link
Copy Markdown
Owner

No description provided.

…sections

- Added core documentation links for hook definitions, rules, parameters, templates, and examples.
- Included advanced topics such as API reference, security best practices, performance tuning, troubleshooting, and migration guide.
- Updated security section to reference the security policy document.
- Improved the configuration validation feature to provide more detailed error messages and feedback during application startup.
- Updated validation logic to handle edge cases and improve user experience.
- Refined documentation to include new validation scenarios and examples.
…ing guidelines

- Added a section for a comprehensive security guide, linking to best practices in both English and Chinese.
- Updated the vulnerability reporting section to include detailed steps for responsible disclosure and information to provide when reporting vulnerabilities.
…examples

- Revised the introduction to emphasize WebHook's security, performance, and configurability.
- Expanded the key features section with detailed bullet points highlighting security measures, performance optimizations, and internationalization support.
- Added comprehensive use cases to illustrate practical applications of WebHook in CI/CD automation, service integration, and custom workflows.
- Updated installation instructions and examples for running WebHook, including Docker and source build options.
- Enhanced the configuration section with examples for defining hooks and securing them with trigger rules.
- Improved documentation clarity and structure for better user experience.
@soulteary soulteary merged commit 8e1fc2b into main Jan 7, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant