Add doc

app.py

@@ -43,7 +43,7 @@ llm_router = Router(model_list=[
 prompt_env = Environment(loader=FileSystemLoader(
     'prompts'), enable_async=True, undefined=StrictUndefined)
 
-api = FastAPI(docs_url="/")
+api = FastAPI(docs_url="/", title="Reqxtract-API", description=open("docs/docs.md").read())
 # requirements routes
 requirements_router = APIRouter(prefix="/reqs", tags=["requirements"])
 # solution routes
@@ -114,7 +114,7 @@ async def categorize_reqs(params: ReqGroupingRequest) -> ReqGroupingResponse:
 
 @solution_router.post("/search_solutions_gemini", response_model=SolutionSearchResponse)
 async def search_solutions(params: ReqGroupingResponse) -> SolutionSearchResponse:
-    """Searches solutions using Gemini and grounded on google search"""
+    """Searches solutions solving the given grouping params using Gemini and grounded on google search"""
 
     async def _search_inner(cat: ReqGroupingCategory) -> SolutionModel:
         # ================== generate the solution with web grounding

docs/docs.md

@@ -0,0 +1,9 @@
+# Reqxtract-API
+
+This project exposes the API used by reqxtract to perform the following functions:
+- categorize extracted requirements, 
+- search and generate solutions solving those requirements, 
+- criticize those solutions 
+- refine the generated solutions based on the critics. 
+    
+Please consult the OpenAPI doc for more information on the endpoints.