Repository navigation
Improve XEvents GitHub presentation and contributor onboarding - #5
Merged
Merged
Conversation
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
1 participant
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.
Visitors previously reached a long, text-only introduction and clone instructions pointing at the XEvents mirror. This change gives the canonical repository a shorter visual README with a prominent Telegram demo, supported feature summary, self-hosting entry point and contribution links. The previous detailed introduction is preserved in
docs/overview.md.Validation: all 431 regression tests passed;
npm run test:workerpassed (dry-run bundle and local mocked integration); 125 internal links/anchors checked; 25 external URLs returned HTTP 200; staged diff whitespace checks passed. A heuristic credential-pattern scan covered all 600 reachable historical blobs and the staged content without matches.Limitations: the banner is branding artwork, not a product screenshot. Real Telegram UI captures and a live mobile bot walkthrough remain pending; HTTP reachability does not verify bot behaviour. No application modules, secrets, deployment configuration or production data were changed. No deployment or merge was performed.