diff --git a/README.md b/README.md index 79dc06b0..65aa8bba 100644 --- a/README.md +++ b/README.md @@ -1,129 +1,375 @@ -# Crowd Source FAQ (Yaksha FAQ Portal) +
+
+
+
+ AI-Powered Knowledge Management & Community FAQ Platform +
+ ++ + + + + + + + + +
+ ++ Repository • + Installation • + Our Contributions • + Contributors +
--- -## Vision +## Table of Contents + +- [Overview](#overview) +- [Key Features](#key-features) +- [Phase 1 Feature Enhancements](#phase-1-feature-enhancements) +- [Bug Fixes](#bug-fixes) +- [Technology Stack](#technology-stack) +- [System Architecture](#system-architecture) +- [Project Structure](#project-structure) +- [Installation](#installation) +- [Environment Variables](#environment-variables) +- [Development Workflow](#development-workflow) +- [Testing](#testing) +- [Challenges & Limitations](#challenges--limitations) +- [Future Enhancements](#future-enhancements) +- [Contributors](#contributors) +- [Contributing](#contributing) +- [Acknowledgements](#acknowledgements) +- [License](#license) -**Automate the FAQ lifecycle end-to-end. Zero people in the loop. Reduce the operational FAQ culture.** +--- -Every question a user has has been asked before — and most will be asked again. The right answer should be there before the user finishes typing. The platform achieves this through four zero-touch pillars: +## Overview -- **Zero-touch ingestion** — Zoom meetings, webhooks, and manual uploads feed the knowledge base without human scheduling, categorising, or approval. -- **Zero-touch answering** — A 24-hour scheduler matches unanswered posts against the knowledge base; high-confidence matches auto-post, low-confidence escalate to humans. -- **Zero-touch quality control** — Approved FAQs are re-evaluated every 6 hours; drift, contradictions, and staleness are detected and flagged automatically. -- **Zero-touch user lifecycle** — Deletion is anonymisation, not destruction. Reputation, attribution, and audit history persist. +Crowd Source FAQ (CSFAQ) is an AI-powered knowledge management platform that lets users search FAQs, participate in community discussions, ask questions, and get intelligent, source-cited answers through semantic search and AI-assisted retrieval. -The platform is the operator. People handle exceptions, not the steady state. +The platform combines community-driven knowledge sharing with AI-powered search to reduce repetitive questions, improve response quality, and give both users and administrators a single, organized, self-maintaining knowledge base. + +This repository reflects our team's contributions during **Phase 1** of the AI internship programme, built on top of the existing CSFAQ (Yaksha FAQ Portal) codebase. --- -## About +## Key Features + +| + +**User** +- AI-powered FAQ Search +- Community Discussion Forum +- Ask Questions +- My Questions Dashboard +- Saved Knowledge +- Draft Persistence +- Internship Roadmap +- Welcome Package +- Program Portal +- Support Ticket System +- Golden Ticket Module +- Email Notifications + + | ++ +**AI** +- Semantic Search +- Intelligent Knowledge Retrieval +- AI Answer Ranking Optimisation +- Multi-source Response Selection +- Context-aware Search + + | ++ +**Admin** +- FAQ Management +- Community Moderation +- Manual FAQ Promotion +- User Management +- AI Configuration +- Feature Flag Management +- Knowledge Management +- Support Dashboard +- Program & Batch Management +- Analytics Dashboard + + | +