Conversation
There was a problem hiding this comment.
Pull request overview
This PR significantly simplifies the README.md and CONTRIBUTING.md documentation by moving detailed content to a wiki. The changes create a more focused landing page that directs users to comprehensive wiki documentation for in-depth information.
Key Changes:
- Condensed README.md from ~600 lines to ~94 lines, replacing extensive inline documentation with wiki links
- Simplified CONTRIBUTING.md to reference the wiki for detailed contribution guidelines
- Replaced detailed configuration examples, API documentation, and technical specifications with a curated list of wiki page links
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Streamlined to provide quick start guide and installation instructions; removed extensive configuration documentation in favor of wiki links organized by topic (Configuration, Subscribers, Filtering, Retry/Dead-Letter, Dashboard, Docker, Schema Support, Architecture) |
| .github/CONTRIBUTING.md | Simplified to quick start steps with reference to detailed wiki page for CI/CD workflows, release process, and conventional commits |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.