refactor: Update project structure in README to enhance clarity and organization
This commit is contained in:
parent
7a883846c9
commit
31206e8fce
37
README.md
37
README.md
|
|
@ -42,18 +42,37 @@ graph TD
|
||||||
## Project Structure
|
## Project Structure
|
||||||
|
|
||||||
```text
|
```text
|
||||||
.
|
|
||||||
├── .github/
|
|
||||||
│ └── pull_request_template.md # Mandatory PR checklist
|
|
||||||
├── Dockerfile # Container definition for the Engine
|
|
||||||
├── README.md # System documentation & Dev guide
|
├── README.md # System documentation & Dev guide
|
||||||
├── CONTRIBUTING.md # Contribution standards & policies
|
|
||||||
├── changelog # Version tracking and release history
|
├── changelog # Version tracking and release history
|
||||||
├── docker-compose.yaml # Local orchestration for dev environment
|
├── pyproject.toml # Python project configuration
|
||||||
├── protos/
|
├── Docker/
|
||||||
│ └── brunix.proto # Protocol Buffers: The source of truth for the API
|
│ ├── Dockerfile # Container definition for the Engine
|
||||||
|
│ ├── docker-compose.yaml # Local orchestration for dev environment
|
||||||
|
│ ├── requirements.txt # Python dependencies for Docker
|
||||||
|
│ ├── protos/
|
||||||
|
│ │ └── brunix.proto # Protocol Buffers: The source of truth for the API
|
||||||
|
│ └── src/
|
||||||
|
│ ├── graph.py # Workflow graph orchestration
|
||||||
|
│ ├── prompts.py # Centralized prompt definitions
|
||||||
|
│ ├── server.py # gRPC Server & RAG Orchestration
|
||||||
|
│ ├── state.py # Shared state management
|
||||||
|
│ └── utils/ # Utility modules
|
||||||
|
├── ingestion/
|
||||||
|
│ └── docs/ # AVAP documentation chunks
|
||||||
|
├── kubernetes/
|
||||||
|
│ └── kubeconfig.yaml # Kubernetes cluster configuration
|
||||||
|
├── scripts/
|
||||||
|
│ └── pipelines/
|
||||||
|
│ ├── flows/ # Data processing flows
|
||||||
|
│ └── tasks/ # Pipeline task definitions
|
||||||
└── src/
|
└── src/
|
||||||
└── server.py # Core Logic: gRPC Server & RAG Orchestration
|
├── __init__.py
|
||||||
|
├── config.py # Application configuration
|
||||||
|
└── utils/
|
||||||
|
├── emb_factory.py # Embedding model factory
|
||||||
|
├── llm_factory.py # LLM model factory
|
||||||
|
└── __init__.py
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue