Skip to content

docs: normalize heading hierarchy in system components section #289

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
Mohit-001-hash wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: normalize heading hierarchy in system components section #289

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,25 +83,25 @@ Ell-ena uses PostgreSQL (via Supabase) with strict Row-Level Security (RLS) and

## ✨ System Components

#### 1. Frontend Layer (Flutter)
### 1. Frontend Layer (Flutter)
- **Auth Module**: Handles user authentication, team management, and role-based access control
- **Task Manager**: Processes task creation, updates, and workflow management
- **Meeting Manager**: Manages meeting scheduling, transcription, and contextual analysis
- **Chat Interface**: Provides natural language interaction with the AI assistant

Comment on lines +86 to 91

@coderabbitai coderabbitai Bot Jul 4, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Add a blank line after this heading.

MD022 flags the heading as not being surrounded by blank lines; insert one blank line before the list for cleaner Markdown rendering. As per path instructions, Markdown files should have proper formatting and structure.

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 86-86: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 86 - 91, The Markdown heading in the Frontend Layer
section is missing surrounding blank lines, triggering MD022. Update the README
content near the Frontend Layer heading so there is one blank line after the
heading before the list, keeping the existing list items intact and preserving
proper Markdown structure.

Sources: Path instructions, Linters/SAST tools

#### 2. Supabase Service Layer
### 2. Supabase Service Layer
- **Auth Client**: Manages authentication tokens and session state
- **Data Client**: Handles real-time data synchronization with PostgreSQL
- **Storage Client**: Manages file uploads and retrieval
- **RPC Client**: Executes remote procedure calls to Edge Functions

Comment on lines +92 to 97

@coderabbitai coderabbitai Bot Jul 4, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Add a blank line after this heading.

MD022 flags the heading as not being surrounded by blank lines; insert one blank line before the list for cleaner Markdown rendering. As per path instructions, Markdown files should have proper formatting and structure.

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 92-92: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 92 - 97, The Markdown heading in README should be
surrounded by blank lines to satisfy MD022 formatting. Update the section around
the “2. Supabase Service Layer” heading so there is a blank line after the
heading before the bullet list, keeping the rest of the list content unchanged.

Sources: Path instructions, Linters/SAST tools

#### 3. Backend Layer (Supabase)
### 3. Backend Layer (Supabase)
- **Authentication**: Handles user identity, security, and session management
- **PostgreSQL DB**: Stores structured data with Row-Level Security policies
- **Object Storage**: Manages binary assets like audio recordings and documents
- **Edge Functions**: Executes serverless functions for business logic

Comment on lines +98 to 103

@coderabbitai coderabbitai Bot Jul 4, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Add a blank line after this heading.

MD022 flags the heading as not being surrounded by blank lines; insert one blank line before the list for cleaner Markdown rendering. As per path instructions, Markdown files should have proper formatting and structure.

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 98-98: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 98 - 103, The Markdown section under the “3. Backend
Layer (Supabase)” heading is missing the required blank line before the list,
which triggers MD022. Update the README content around that heading so there is
one empty line between the heading and the first bullet item, keeping the rest
of the list unchanged.

Sources: Path instructions, Linters/SAST tools

#### 4. AI Processing Pipeline
### 4. AI Processing Pipeline

@coderabbitai coderabbitai Bot Jul 4, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Add a blank line after this heading.

MD022 flags the heading as not being surrounded by blank lines; insert one blank line before the list for cleaner Markdown rendering. As per path instructions, Markdown files should have proper formatting and structure.

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 104-104: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 104, The Markdown heading in README.md is missing proper
surrounding spacing, triggering MD022. Update the AI Processing Pipeline section
so the heading is followed by a blank line before the next list/content, keeping
the Markdown structure clean and correctly formatted.

Sources: Path instructions, Linters/SAST tools

- **NLU Processor**: Processes natural language using Gemini API
- **Vector Database**: Stores and retrieves semantic embeddings for context-aware searches
- **Embedding Generator**: Creates vector embeddings from text for semantic similarity
Expand Down