DOCS: Updated Documentation to incorporate latest changes and updates #179
Conversation
WalkthroughREADME.md was comprehensively restructured: new Table of Contents, expanded Features (AI-driven capabilities), reorganized Tech Stack, Project Structure tree, detailed Installation & Setup, Running instructions, API documentation, troubleshooting, contributor guidance, and workflow diagrams. Changes
Sequence Diagram(s)(Skipped — changes are documentation-only and do not alter runtime control flow.) Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@CodeRabbit review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
README.md (4)
102-172: Add language specifier to code block for proper syntax highlighting.The project structure code block is missing a language identifier. While this may render, it prevents proper syntax highlighting and validation.
Apply this change:
-``` +```plaintext InPactAI/
338-344: Add language specifiers to PostgreSQL connection string code blocks.These code blocks lack language identifiers for syntax highlighting.
Apply these changes:
- For IPv6 networks, use the direct connection: - ``` + ```bash postgresql://postgres:[YOUR-PASSWORD]@db.xxxxx.supabase.co:5432/postgres - ``` + ``` - For IPv4 networks or if you encounter connection issues, use the Session Pooler: - ``` + ```bash postgresql://postgres.xxxxx:[YOUR-PASSWORD]@aws-0-region.pooler.supabase.com:6543/postgres - ``` + ```
458-461: Add language specifier to npm command code block.Missing language identifier for syntax highlighting.
-``` npm run dev -``` +```
676-744: Convert troubleshooting issue headers from emphasis to proper markdown headings.The troubleshooting section uses bold text (e.g.,
**Issue: ...**) instead of proper markdown heading syntax. This makes the document structure unclear and violates markdown conventions.Convert emphasis-based headers to proper markdown headings using
####. For example:-#### Frontend Issues +#### Frontend Issues -**Issue: "Missing Supabase environment variables"** -- **Solution**: Ensure `.env.local` exists in the `frontend` directory with all required variables +##### Missing Supabase Environment Variables + +Ensure `.env.local` exists in the `frontend` directory with all required variables:Apply this pattern consistently throughout the Troubleshooting section (lines 682-739) for all Issue/Solution pairs. This improves document structure, navigation, and readability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(4 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
11-11: Link fragments should be valid
(MD051, link-fragments)
12-12: Link fragments should be valid
(MD051, link-fragments)
13-13: Link fragments should be valid
(MD051, link-fragments)
14-14: Link fragments should be valid
(MD051, link-fragments)
15-15: Link fragments should be valid
(MD051, link-fragments)
21-21: Link fragments should be valid
(MD051, link-fragments)
22-22: Link fragments should be valid
(MD051, link-fragments)
23-23: Link fragments should be valid
(MD051, link-fragments)
24-24: Link fragments should be valid
(MD051, link-fragments)
25-25: Link fragments should be valid
(MD051, link-fragments)
26-26: Link fragments should be valid
(MD051, link-fragments)
27-27: Link fragments should be valid
(MD051, link-fragments)
102-102: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
338-338: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
342-342: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
459-459: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
682-682: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
686-686: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
690-690: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
696-696: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
702-702: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
707-707: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
714-714: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
721-721: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
725-725: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
734-734: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
739-739: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
839-839: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (1)
README.md (1)
204-206: Fix repository clone URL to match current project naming.The clone URL references "InPact" but the PR context and GitHub URL indicate the repository is named "InPactAI". This will cause users to clone the incorrect repository.
Apply this change:
-git clone https://github.com/AOSSIE-Org/InPact.git -cd InPact +git clone https://github.com/AOSSIE-Org/InPactAI.git +cd InPactAILikely an incorrect or invalid review comment.
|
@CodeRabbit review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 6
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(4 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
11-11: Link fragments should be valid
(MD051, link-fragments)
12-12: Link fragments should be valid
(MD051, link-fragments)
13-13: Link fragments should be valid
(MD051, link-fragments)
14-14: Link fragments should be valid
(MD051, link-fragments)
15-15: Link fragments should be valid
(MD051, link-fragments)
21-21: Link fragments should be valid
(MD051, link-fragments)
22-22: Link fragments should be valid
(MD051, link-fragments)
23-23: Link fragments should be valid
(MD051, link-fragments)
24-24: Link fragments should be valid
(MD051, link-fragments)
25-25: Link fragments should be valid
(MD051, link-fragments)
26-26: Link fragments should be valid
(MD051, link-fragments)
27-27: Link fragments should be valid
(MD051, link-fragments)
111-111: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
351-351: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
355-355: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
478-478: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
712-712: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
717-717: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
722-722: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
729-729: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
736-736: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
742-742: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
750-750: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
758-758: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
763-763: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
773-773: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
779-779: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
895-895: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (2)
README.md (2)
802-815: ✅ Contribution workflow now correctly addresses fork/clone process.The GitHub-first workflow (fork on GitHub, clone fork locally, add upstream remote) is now properly documented and addresses the previous invalid
git forkcommand issue.
216-217: The review comment contains incorrect line number references.The actual repository name should indeed be
InPactAI(confirmed by successful GitHub access). However, the review incorrectly identifies multiple line numbers (216, 809, 815, 875, 790) that either don't exist in the 271-line README.md or don't contain git clone commands. The only actual reference toInPact.gitthat needs updating is at line 87, not the multiple locations claimed:git clone https://github.com/AOSSIE-Org/InPact.git cd inpactThis should be updated to:
git clone https://github.com/AOSSIE-Org/InPactAI.git cd inpactaiThe claims about "inconsistencies throughout the file" at the specified line numbers are unfounded.
Likely an incorrect or invalid review comment.
| ## 📋 Table of Contents | ||
|
|
||
| - [Features](#features) | ||
| - [Tech Stack](#tech-stack) | ||
| - [Project Structure](#project-structure) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Installation & Setup](#installation--setup) | ||
| - [1. Clone the Repository](#1-clone-the-repository) | ||
| - [2. Frontend Setup](#2-frontend-setup) | ||
| - [3. Backend Setup](#3-backend-setup) | ||
| - [4. Database Setup](#4-database-setup) | ||
| - [5. Environment Variables](#5-environment-variables) | ||
| - [Running the Application](#running-the-application) | ||
| - [API Documentation](#api-documentation) | ||
| - [Usage Guide](#usage-guide) | ||
| - [Project Workflow](#project-workflow) | ||
| - [Troubleshooting](#troubleshooting) | ||
| - [Contributing](#contributing) | ||
| - [Contact](#contact) |
There was a problem hiding this comment.
🧩 Analysis chain
Fix Table of Contents link fragments broken by emoji in headings.
Headings contain emoji characters (e.g., ## ✨ Features) which break anchor link generation in many markdown renderers. The TOC links will fail to navigate to these sections on some platforms.
Remove emoji from heading anchors while keeping them in the displayed text:
-## ✨ Features
+## Features
-## 🛠 Tech Stack
+## Tech Stack
-## 📁 Project Structure
+## Project Structure
-## 📋 Prerequisites
+## Prerequisites
-## 🚀 Installation & Setup
+## Installation & Setup
-## 🏃 Running the Application
+## Running the Application
-## 📚 API Documentation
+## API Documentation
-## 📖 Usage Guide
+## Usage Guide
-## 🔄 Project Workflow
+## Project Workflow
-## 🔧 Troubleshooting
+## Troubleshooting
-## 🤝 Contributing
+## Contributing
-## 📞 Contact
+## Contact
-## 📄 License
+## License
-## 🙏 Acknowledgments
+## AcknowledgmentsAlternatively, if you prefer keeping emoji in headings for visual appeal, update the TOC to use explicit anchor links instead of auto-generated ones:
- [Features](#features)
+ [Features](#-features)(depending on how your renderer generates anchors). Test the links after any changes.
I'll verify the review comment by examining the README.md file and researching how markdown renderers handle emoji in headings.
---
🏁 Script executed:
```shell
#!/bin/bash
# Extract heading lines from README.md to verify emoji presence
rg -n "^##\s+" README.md | head -20
Length of output: 367
🌐 Web query:
markdown emoji in headings anchor links compatibility
💡 Result:
Short answer
- Emoji in headings is supported visually, but automatic anchor/slug generation is inconsistent across renderers (GitHub, GitLab, Jekyll, VSCode extensions), so heading links may break or produce unexpected IDs. [1][2][3][4]
Details (concise)
- GitHub: headings are slugified/auto‑ID’d by github.com; rules can remove or normalize emoji differently than you expect. Relying on emoji inside headings can yield unpredictable anchors. [4][2]
- GitLab / GitLab Handbook: emoji render is supported, but heading ID/anchor behavior is a separate slugification step — GitLab documents and community posts show differing results when emoji are present. [0][1]
- Editors/plugins: some markdown tools/extensions strip emoji when building the slug, causing broken links or TOC mismatches (example issue in VS Code markdown extension). [3]
Recommendation (single reliable approach)
- Don’t rely on implicit IDs when you need stable links. Add an explicit id/anchor next to the heading:
References
- GitLab Markdown & emoji docs. [0]
- GitLab Handbook: anchors/heading IDs. [1]
- GitHub Pages / Jekyll & emoji notes. [2]
- VS Code markdown extension issue: emoji in headings breaks links. [3]
- GitHub / Markdown anchor behavior discussion (slugification and auto IDs). [4]
Fix Table of Contents link fragments broken by emoji in headings.
Emoji in markdown headings causes inconsistent anchor/slug generation across platforms. GitHub, GitLab, Jekyll, and VS Code markdown extensions handle emoji differently during slugification, resulting in unpredictable heading IDs. This causes TOC links to break when navigating between platforms.
Remove emoji from heading anchors while preserving visual appeal:
-## ✨ Features
+## Features
-## 🛠 Tech Stack
+## Tech Stack
-## 📁 Project Structure
+## Project Structure
-## 📋 Prerequisites
+## Prerequisites
-## 🚀 Installation & Setup
+## Installation & Setup
-## 🏃 Running the Application
+## Running the Application
-## 📚 API Documentation
+## API Documentation
-## 📖 Usage Guide
+## Usage Guide
-## 🔄 Project Workflow
+## Project Workflow
-## 🔧 Troubleshooting
+## Troubleshooting
-## 🤝 Contributing
+## Contributing
-## 📞 Contact
+## Contact
-## 📄 License
+## License
-## 🙏 Acknowledgments
+## AcknowledgmentsAlternatively, use explicit anchor syntax (e.g., ## Features {#features} for Kramdown) or HTML anchors to maintain emoji in headings while guaranteeing cross-platform compatibility.
Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
11-11: Link fragments should be valid
(MD051, link-fragments)
12-12: Link fragments should be valid
(MD051, link-fragments)
13-13: Link fragments should be valid
(MD051, link-fragments)
14-14: Link fragments should be valid
(MD051, link-fragments)
15-15: Link fragments should be valid
(MD051, link-fragments)
21-21: Link fragments should be valid
(MD051, link-fragments)
22-22: Link fragments should be valid
(MD051, link-fragments)
23-23: Link fragments should be valid
(MD051, link-fragments)
24-24: Link fragments should be valid
(MD051, link-fragments)
25-25: Link fragments should be valid
(MD051, link-fragments)
26-26: Link fragments should be valid
(MD051, link-fragments)
27-27: Link fragments should be valid
(MD051, link-fragments)
🤖 Prompt for AI Agents
In README.md around lines 9 to 27 the Table of Contents links break because
emoji in headings produce inconsistent anchor slugs across platforms; remove
emoji from the generated heading anchors or add explicit, platform-agnostic
anchors to the headings (either using Kramdown-style {#id} or HTML anchor tags)
and update the TOC entries to reference those explicit IDs so links work
consistently while keeping emoji in the visible heading if desired.
| ``` | ||
| InPactAI/ | ||
| ├── frontend/ # Next.js frontend application | ||
| │ ├── app/ # Next.js App Router | ||
| │ │ ├── brand/ # Brand-specific pages | ||
| │ │ │ ├── analytics/ # Analytics dashboard | ||
| │ │ │ ├── campaigns/ # Campaign management | ||
| │ │ │ ├── contracts/ # Contract management | ||
| │ │ │ ├── home/ # Brand dashboard | ||
| │ │ │ ├── onboarding/ # Brand onboarding flow | ||
| │ │ │ └── proposals/ # Proposal management | ||
| │ │ ├── creator/ # Creator-specific pages | ||
| │ │ │ ├── analytics/ # Creator analytics | ||
| │ │ │ ├── collaborations/ # Collaboration hub | ||
| │ │ │ ├── contracts/ # Contract management | ||
| │ │ │ ├── home/ # Creator dashboard | ||
| │ │ │ ├── onboarding/ # Creator onboarding flow | ||
| │ │ │ └── proposals/ # Proposal applications | ||
| │ │ ├── login/ # Login page | ||
| │ │ ├── signup/ # Signup page | ||
| │ │ └── layout.tsx # Root layout | ||
| │ ├── components/ # Reusable React components | ||
| │ │ ├── analytics/ # Analytics components | ||
| │ │ ├── auth/ # Authentication components | ||
| │ │ ├── contracts/ # Contract components | ||
| │ │ ├── dashboard/ # Dashboard components | ||
| │ │ └── onboarding/ # Onboarding components | ||
| │ ├── lib/ # Utility libraries | ||
| │ │ ├── api/ # API client functions | ||
| │ │ ├── auth-helpers.ts # Auth utilities | ||
| │ │ ├── campaignApi.ts # Campaign API client | ||
| │ │ ├── geminiApi.ts # Gemini API client | ||
| │ │ └── supabaseClient.ts # Supabase client | ||
| │ ├── types/ # TypeScript type definitions | ||
| │ ├── public/ # Static assets | ||
| │ ├── package.json # Frontend dependencies | ||
| │ └── next.config.ts # Next.js configuration | ||
| │ | ||
| ├── backend/ # FastAPI backend application | ||
| │ ├── app/ # Main application code | ||
| │ │ ├── api/ # API routes | ||
| │ │ │ └── routes/ # Route handlers | ||
| │ │ │ ├── analytics.py # Analytics endpoints | ||
| │ │ │ ├── auth.py # Authentication endpoints | ||
| │ │ │ ├── campaigns.py # Campaign endpoints | ||
| │ │ │ ├── collaborations.py # Collaboration endpoints | ||
| │ │ │ ├── creators.py # Creator endpoints | ||
| │ │ │ ├── gemini_generate.py # Gemini AI endpoints | ||
| │ │ │ ├── groq_generate.py # Groq AI endpoints | ||
| │ │ │ ├── health.py # Health check endpoints | ||
| │ │ │ └── proposals.py # Proposal endpoints | ||
| │ │ ├── core/ # Core application logic | ||
| │ │ │ ├── config.py # Configuration settings | ||
| │ │ │ ├── dependencies.py # FastAPI dependencies | ||
| │ │ │ ├── security.py # Security utilities | ||
| │ │ │ └── supabase_clients.py # Supabase clients | ||
| │ │ ├── db/ # Database utilities | ||
| │ │ ├── models/ # Pydantic models | ||
| │ │ ├── services/ # Business logic services | ||
| │ │ └── main.py # FastAPI application entry point | ||
| │ ├── requirements.txt # Python dependencies | ||
| │ └── env_example # Environment variables example | ||
| │ | ||
| ├── docs/ # Documentation | ||
| │ └── database/ # Database schema documentation | ||
| │ | ||
| ├── guides/ # Implementation guides | ||
| │ └── summaries/ # Feature implementation summaries | ||
| │ | ||
| └── README.md # This file | ||
| ``` |
There was a problem hiding this comment.
Add language specification to Project Structure code block (MD040).
Fenced code blocks should specify a language for syntax highlighting and consistency.
-```
+```
InPactAI/Consider text or tree if available in your renderer:
-```
+```text
InPactAI/🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
111-111: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In README.md around lines 111–181 the fenced code block showing the project tree
lacks a language spec which triggers MD040; update the opening fence from ``` to
include a language (e.g., ```text or ```tree) so the block becomes ```text (or
```tree) and leave the closing fence unchanged; no other content changes are
needed.
| ``` | ||
| postgresql://postgres:[YOUR-PASSWORD]@db.xxxxx.supabase.co:5432/postgres | ||
| ``` | ||
| - For IPv4 networks or if you encounter connection issues, use the Session Pooler: | ||
| ``` | ||
| postgresql://postgres.xxxxx:[YOUR-PASSWORD]@aws-0-region.pooler.supabase.com:6543/postgres | ||
| ``` |
There was a problem hiding this comment.
Add language specification to database connection string code block (MD040).
- ```
+ ```sql
postgresql://postgres:[YOUR-PASSWORD]@db.xxxxx.supabase.co:5432/postgres
- ```
+ ```Repeat for the Session Pooler example on line 355.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
351-351: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
355-355: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In README.md around lines 351 to 357, the fenced code blocks for the database
connection strings lack a language spec (MD040); update both fences to use the
SQL language tag by replacing the opening triple backticks with ```sql for the
main connection string and for the Session Pooler example on line 355, keeping
the content and closing backticks unchanged.
| ```` | ||
| The frontend will be available at: `http://localhost:3000` | ||
| ### Production Build | ||
| #### Build Frontend | ||
| ```bash | ||
| cd frontend | ||
| npm run build | ||
| npm start | ||
| ```` |
There was a problem hiding this comment.
Add language specification to production build code block (MD040).
-````
+```bashAlso fix the mismatched fence markers (4 backticks instead of 3).
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
478-478: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In README.md around lines 478 to 490, the production build code block uses an
extra backtick fence and lacks a language tag; change the opening fence to three
backticks with "bash" (```bash) and the closing fence to three backticks (```)
so the block is properly fenced and syntax-highlighted, ensuring the promo text
above remains outside the code block.
| #### Frontend Issues | ||
|
|
||
| **Issue: "Missing Supabase environment variables"** | ||
|
|
||
| - **Solution**: Ensure `.env.local` exists in the `frontend` directory with all required variables | ||
| - Check that variable names start with `NEXT_PUBLIC_` for client-side access | ||
|
|
||
| **Issue: "NEXT_PUBLIC_API_URL is missing or not valid"** | ||
|
|
||
| - **Solution**: For local development, set `NEXT_PUBLIC_API_URL=http://localhost:8000` | ||
| - For production, ensure it's a valid HTTPS URL | ||
|
|
||
| **Issue: Build fails with TypeScript errors** | ||
|
|
||
| - **Solution**: Run `npm install` to ensure all dependencies are installed | ||
| - Check that TypeScript version is compatible (v5+) | ||
|
|
||
| #### Backend Issues | ||
|
|
||
| **Issue: "Supabase client initialization failed"** | ||
|
|
||
| - **Solution**: | ||
| - Verify `SUPABASE_URL` and `SUPABASE_KEY` in `.env` | ||
| - Check that your Supabase project is active | ||
| - Ensure network connectivity to Supabase | ||
|
|
||
| **Issue: "JWT verification failed"** | ||
|
|
||
| - **Solution**: | ||
| - Verify `SUPABASE_JWT_SECRET` matches the JWT Secret in Supabase dashboard | ||
| - Ensure you're using the JWT Secret, not the anon key | ||
|
|
||
| **Issue: Database connection errors** | ||
|
|
||
| - **Solution**: | ||
| - Check `DATABASE_URL` format (if using direct connection) | ||
| - For IPv4 networks, use Session Pooler connection string | ||
| - Verify database password is correct | ||
| - Check Supabase project status | ||
|
|
||
| **Issue: "Module not found" errors** | ||
|
|
||
| - **Solution**: | ||
| - Activate virtual environment: `source venv/bin/activate` | ||
| - Reinstall dependencies: `pip install -r requirements.txt` | ||
|
|
||
| #### Database Issues | ||
|
|
||
| **Issue: Tables don't exist** | ||
|
|
||
| - **Solution**: Run the SQL schema script in Supabase SQL Editor | ||
| - Check that all ENUM types are created before tables | ||
|
|
||
| **Issue: "onboarding_completed column doesn't exist"** | ||
|
|
||
| - **Solution**: Run the ALTER TABLE command: | ||
| ```sql | ||
| ALTER TABLE profiles | ||
| ADD COLUMN IF NOT EXISTS onboarding_completed BOOLEAN DEFAULT FALSE; | ||
| ``` | ||
|
|
||
| For queries, issues, or feature requests, please raise an issue or reach out on our Discord server. | ||
| #### API Issues | ||
|
|
||
| **Issue: CORS errors** | ||
|
|
||
| - **Solution**: | ||
| - Add frontend URL to `ALLOWED_ORIGINS` in backend `.env` | ||
| - Ensure backend CORS middleware is configured correctly | ||
|
|
||
| **Issue: 401 Unauthorized errors** | ||
|
|
||
| - **Solution**: | ||
| - Verify JWT token is being sent in request headers | ||
| - Check token expiration | ||
| - Ensure user is logged in | ||
|
|
||
| ### Getting Help | ||
|
|
||
| If you encounter issues not covered here: | ||
|
|
||
| 1. Check the [Issues](https://github.com/AOSSIE-Org/InPact/issues) page | ||
| 2. Review the documentation in the `docs/` and `guides/` directories | ||
| 3. Reach out on Discord or create a new issue | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Replace bold emphasis with proper headings in Troubleshooting section (MD036).
Lines like **Issue: "..."** and **Solution: ...** use emphasis where structural headings would be more semantically correct and linter-compliant.
Refactor troubleshooting subsections to use proper markdown headings:
#### Frontend Issues
-**Issue: "Missing Supabase environment variables"**
+**Missing Supabase environment variables**
-- **Solution**: Ensure `.env.local` exists in the `frontend` directory with all required variables
+Ensure `.env.local` exists in the `frontend` directory with all required variables:
+
- Check that variable names start with `NEXT_PUBLIC_` for client-side access
-**Issue: "NEXT_PUBLIC_API_URL is missing or not valid"**
+**NEXT_PUBLIC_API_URL is missing or not valid**
-- **Solution**: For local development, set `NEXT_PUBLIC_API_URL=http://localhost:8000`
+For local development, set `NEXT_PUBLIC_API_URL=http://localhost:8000`:
+
- For production, ensure it's a valid HTTPS URLApply this pattern consistently across all Frontend, Backend, Database, and API Issues sections (lines 712–784).
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
712-712: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
717-717: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
722-722: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
729-729: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
736-736: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
742-742: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
750-750: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
758-758: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
763-763: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
773-773: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
779-779: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🤖 Prompt for AI Agents
README.md around lines 710–793: the Troubleshooting subsections currently use
bold emphasis for "Issue:" and "Solution:" which violates MD036; replace each
bolded Issue and Solution line with proper markdown headings (e.g., use
consistent heading levels like "#### Issue: ..." and "##### Solution:" or
similar) and convert repeated bolded labels into semantic headings for every
Frontend, Backend, Database, and API subsection across lines 712–784 so the
structure is linter-compliant and consistent.
|
|
||
| If you encounter issues not covered here: | ||
|
|
||
| 1. Check the [Issues](https://github.com/AOSSIE-Org/InPact/issues) page |
There was a problem hiding this comment.
🧩 Analysis chain
Verify repository URL is consistently updated to InPactAI.
After fixing the repository name inconsistency noted in line 216, ensure all of these lines reference the correct URL:
- Line 790: Issues link
- Line 803: Fork link
- Line 809: Clone example
- Line 815: Upstream remote
- Line 875: GitHub Issues link
Run this script to confirm all URLs have been updated:
Also applies to: 803-803, 809-809, 815-815, 875-875
🏁 Script executed:
#!/bin/bash
# Verify all GitHub URLs reference InPactAI consistently
rg 'github\.com/AOSSIE-Org/(InPact|InPactAI)' README.md -nLength of output: 428
Update all GitHub repository URLs from InPact to InPactAI in README.md.
The repository name has not been consistently updated. All occurrences still reference InPact:
- Line 216: Clone URL
- Line 790: Issues link
- Line 803: Fork link
- Line 815: Upstream remote
- Line 875: GitHub Issues link
Update all instances to use InPactAI instead of InPact.
🤖 Prompt for AI Agents
In README.md (lines 216, 790, 803, 815, 875): update every occurrence of the
repository name and GitHub URLs from "InPact" to "InPactAI" — specifically fix
the clone URL, the Issues link at line 790, the Fork link at 803, the Upstream
remote at 815, and the GitHub Issues link at 875; perform a repo-wide search for
"InPact" and replace with "InPactAI" in both visible text and URL paths (e.g.,
github.com/AOSSIE-Org/InPact -> github.com/AOSSIE-Org/InPactAI), and verify each
updated link resolves correctly.
📝 Description
This pull request updates the
README.mdto provide clearer, more comprehensive instructions for users and contributors. The changes focus on improving onboarding steps, clarifying environment variable setup, and enhancing the overall structure for better readability. The goal is to make it easier for new users and developers to get started with the project and understand its workflow.🔧 Changes Made
✅ Checklist
Summary by CodeRabbit