External/securelens-backend
1
0
Fork 0
mirror of https://github.com/Rarebuffalo/securelens-backend.git synced 2026-06-19 07:00:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated the docs

Browse Source
This commit is contained in:
rarebuffalo
2026-04-29 16:22:02 +05:30
parent ae4ed3062a
commit 7159f4b9af
6 changed files with 1004 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/README.md Normal file
View File

@@ -0,0 +1,19 @@
# docs/
This folder contains the technical documentation for the SecureLens backend.
## What's Here
| File | What It Explains |
|---|---|
| [ai-agent.md](./ai-agent.md) | How the AI agent works — the three-phase code scanning pipeline, the Gemini integration, the chat system, and the website scanner AI layer |
| [architecture.md](./architecture.md) | How the full system is structured — all layers from the FastAPI app down to the database, and a step-by-step trace of a real request |
| [api-reference.md](./api-reference.md) | Every API endpoint, its request/response shape, and error codes |
## Where to Start
If you want to understand **how the AI works** → [ai-agent.md](./ai-agent.md)
If you want to understand **how the system is structured** → [architecture.md](./architecture.md)
If you're looking for a **specific endpoint** → [api-reference.md](./api-reference.md)