Skip to content

Improve README onboarding with high-level workflow and diagram explanations #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mishrajyoti1405-tech wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve README onboarding with high-level workflow and diagram explanations #52

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38f37bd
Add High level workflow section to README
mishrajyoti1405-tech Dec 16, 2025
402c6a6
Add diagram explanations to improve README clarity
mishrajyoti1405-tech Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,18 @@

The Disgitbot project aims to create a comprehensive Discord bot that integrates GitHub activity with Discord communities, providing real-time notifications, contribution analytics, and automated workflow management. The project focuses on enhancing community engagement and streamlining development workflows through intelligent automation.

## How DisGitBot Works (High-Level)

DisGitBot bridges GitHub repositories and Discord communities by automatically capturing
repository activity and presenting useful insights inside Discord.

At a high level:
1. GitHub webhooks listen for events such as pull requests, commits, and issues
2. Incoming events are validated and processed by backend services
3. Automation and AI-assisted logic handle labeling, reviews, and classification
4. Contribution data is stored and indexed for analytics
5. Results are delivered to Discord via bot commands, roles, and notifications

---

## Timeline & Tasks
Expand Down Expand Up @@ -123,6 +135,10 @@ The Disgitbot project aims to create a comprehensive Discord bot that integrates

<div id="diagram-1-contribution-stats-pipeline">
<h4>Diagram 1: Discord Bot for Real-Time GitHub Contribution Stats - Data Pipeline Architecture</h4>
<h5><i>This diagram shows the end-to-end data pipeline used by DisGitBot to collect GitHub
contribution data, process it through analytics workflows, store results, and expose
real-time statistics to users via Discord commands.</i></h5>


```mermaid
graph TD
Expand Down Expand Up @@ -154,6 +170,10 @@ graph TD

<div id="diagram-2-role-update-system">
<h4>Diagram 2: Discord Role Auto-Update Bot - Role Update Workflow</h4>
<h5><i>This diagram illustrates the automated workflow used by DisGitBot to periodically
evaluate GitHub contributions, determine contributor role levels, and synchronize
Discord server roles based on updated contribution statistics.</h5></i>


```mermaid
graph TD
Expand Down Expand Up @@ -181,6 +201,10 @@ graph TD

<div id="diagram-3-pr-review-integration">
<h4>Diagram 3: AI-Assisted Pull Request Review Integration - PR Review Automation</h4>
<h5><i>This diagram describes the automated pull request review workflow in DisGitBot,
where PR events trigger AI-assisted analysis, metrics computation, label prediction,
reviewer assignment, and notification of review outcomes.</i></h5>


```mermaid
graph TD
Expand Down Expand Up @@ -215,6 +239,10 @@ graph TD

<div id="diagram-4-pr-labeling-workflow">
<h4>Diagram 4: Automatic Labelling for PRs Using PR Labeller - AI Labeling System</h4>
<h5><i>This diagram outlines the AI-driven pull request labeling workflow, where PR events
trigger automated analysis using repository-specific labels, confidence-based
classification, and application of labels to ensure consistent and efficient PR tagging.</i></h5>


```mermaid
graph TD
Expand Down Expand Up @@ -248,6 +276,10 @@ graph TD

<div id="diagram-5-metrics-tracking-system">
<h4>Diagram 5: Research Metric Tracking and Channel Creation - Metrics & Channels</h4>
<h5><i>This diagram shows how DisGitBot periodically aggregates repository metrics and
synchronizes them with Discord by creating and updating channels that display
live repository statistics in real time.
</i><h5>

```mermaid
graph TD
Expand Down Expand Up @@ -275,6 +307,10 @@ graph TD

<div id="diagram-6-analytics-hall-of-fame">
<h4>Diagram 6: Contributor Analytics and Hall of Fame Visualization - Analytics & Visualization</h4>
<h5><i>This diagram illustrates how DisGitBot processes contribution data to generate
analytics, hall-of-fame rankings, and visual insights, which are then exposed
to users through interactive Discord charts and commands.</i><h5>


```mermaid
graph TD
Expand Down