Skip to content

Commit f595ff0

Browse files
committed
docs: enhance API documentation section in README for clarity and usability
1 parent 15004ae commit f595ff0

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -152,18 +152,23 @@ uvicorn app.main:app --reload --host 0.0.0.0 --port 8000
152152
}
153153
```
154154

155-
Docs are auto-generated:
155+
## 📖 API Documentation
156156

157-
- Swagger UI → [http://localhost:8000/docs](http://localhost:8000/docs)
158-
- ReDoc → [http://localhost:8000/redoc](http://localhost:8000/redoc)
157+
Interactive API documentation is available and auto-generated:
158+
159+
- **Swagger UI:** [http://localhost:8000/docs](http://localhost:8000/docs)
160+
Explore and test all endpoints with an intuitive interface.
161+
162+
- **ReDoc:** [http://localhost:8000/redoc](http://localhost:8000/redoc)
163+
Browse comprehensive, well-structured API reference documentation.
159164

160165
---
161166

162167
## 🛠️ Development Notes
163168

164169
- Runs on **FastAPI + Uvicorn**.
165170
- Requires **MongoDB Atlas** with vector index support.
166-
- Uses **OpenAI/HuggingFace LLMs** for text generation.
171+
- Uses **HuggingFace LLMs** for text generation.
167172
- Extendable for custom embeddings and retrieval-augmented generation (RAG).
168173

169174
---

0 commit comments

Comments
 (0)