Skip to content

Commit 386d7aa

Browse files
authored
refactor: reogranize the contents (#235)
Signed-off-by: bitliu <[email protected]>
1 parent 21c945a commit 386d7aa

30 files changed

+919
-242
lines changed

β€Ž.gitignoreβ€Ž

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,4 +114,7 @@ results/
114114

115115
# Cursor editor rules files
116116
.cursorrules
117-
.cursorrules.*
117+
.cursorrules.*
118+
119+
# augment editor rules
120+
.augment

β€Žwebsite/docs/api/router.mdβ€Ž

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -647,8 +647,8 @@ logger.info(f"Request routed to {routing_info.get('selected_model')} "
647647
## Next Steps
648648

649649
- **[Classification API](classification.md)**: Detailed classification endpoints
650-
- **[System Architecture](../architecture/system-architecture.md)**: System monitoring and observability
651-
- **[Quick Start Guide](../getting-started/installation.md)**: Real-world integration examples
652-
- **[Configuration Guide](../getting-started/configuration.md)**: Production configuration
650+
- **[System Architecture](../overview/architecture/system-architecture.md)**: System monitoring and observability
651+
- **[Quick Start Guide](../installation/installation.md)**: Real-world integration examples
652+
- **[Configuration Guide](../installation/configuration.md)**: Production configuration
653653

654654
For more advanced API usage and custom integrations, refer to the examples directory or join our community discussions.

β€Žwebsite/docs/getting-started/semantic-cache.mdβ€Ž

Lines changed: 0 additions & 206 deletions
This file was deleted.

β€Žwebsite/docs/getting-started/configuration.mdβ€Ž renamed to β€Žwebsite/docs/installation/configuration.mdβ€Ž

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 4
3+
---
4+
15
# Global Configuration
26

37
This guide covers the configuration options for the Semantic Router. The system uses a single YAML configuration file that controls all aspects of routing, classification, and security.

β€Žwebsite/docs/getting-started/docker-quickstart.mdβ€Ž renamed to β€Žwebsite/docs/installation/docker-quickstart.mdβ€Ž

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
15
# Install with Docker Compose
26

37
Run Semantic Router + Envoy locally using Docker Compose v2.

β€Žwebsite/docs/getting-started/installation.mdβ€Ž renamed to β€Žwebsite/docs/installation/installation.mdβ€Ž

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
15
# Install in Local
26

37
This guide will help you set up and install the Semantic Router on your system. The router runs entirely on CPU and does not require GPU for inference.

β€Žwebsite/docs/intro.mdβ€Ž

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ The router provides comprehensive monitoring through:
9696

9797
## πŸ”— Quick Links
9898

99-
- [**Getting Started**](getting-started/installation.md) - Setup and installation guide
99+
- [**Installation**](installation/installation.md) - Setup and installation guide
100100
- [**Overview**](overview/semantic-router-overview.md) - Deep dive into semantic routing concepts
101-
- [**Architecture**](architecture/system-architecture.md) - Technical architecture and design
101+
- [**Architecture**](overview/architecture/system-architecture.md) - Technical architecture and design
102102
- [**Model Training**](training/training-overview.md) - How classification models are trained
103103

104104
## πŸ“š Documentation Structure
@@ -108,7 +108,7 @@ This documentation is organized into the following sections:
108108
### 🎯 [Overview](overview/semantic-router-overview.md)
109109
Learn about semantic routing concepts, mixture of models, and how this compares to other routing approaches like RouteLLM and GPT-5's router architecture.
110110

111-
### πŸ—οΈ [Architecture](architecture/system-architecture.md)
111+
### πŸ—οΈ [Architecture](overview/architecture/system-architecture.md)
112112
Understand the system design, Envoy ExtProc integration, and how the router communicates with backend models.
113113

114114
### πŸ€– [Model Training](training/training-overview.md)
File renamed without changes.

β€Žwebsite/docs/architecture/router-implementation.mdβ€Ž renamed to β€Žwebsite/docs/overview/architecture/router-implementation.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -473,4 +473,4 @@ func (pt *PerformanceTracker) RecordClassification(
473473
}
474474
```
475475

476-
This implementation provides the foundation for intelligent, secure, and performant LLM routing. The next section covers [Model Training](../training/training-overview.md), detailing how the classification models are developed and optimized.
476+
This implementation provides the foundation for intelligent, secure, and performant LLM routing. The next section covers [Model Training](../../training/training-overview.md), detailing how the classification models are developed and optimized.
File renamed without changes.

0 commit comments

Comments
Β (0)