mirror of
https://github.com/langchain-ai/langsmith-self-hosted-reference-aws.git
synced 2026-07-01 20:04:39 -04:00
docs: add table of contents to README with navigation guide
Add a comprehensive table of contents to the README that organizes content by deployment phase and provides clear guidance on: - What to do at each stage - When to do it (timing in the deployment process) - Where to find detailed information (section links and related docs) The TOC is organized into four sections: - Getting Started: Initial review and pre-deployment steps - Architecture Reference: Design and planning decisions - Operations & Troubleshooting: Post-deployment guidance - Reference Information: Context and exclusions This improves discoverability and helps users navigate the documentation more effectively by clearly indicating the sequence of activities and where to find specific information.
This commit is contained in:
@@ -9,6 +9,45 @@ Alternative approaches may work, but are **out of scope for P0 enablement and fu
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
### Getting Started
|
||||
|
||||
| What to Do | When to Do It | Where to Find Details |
|
||||
|------------|---------------|----------------------|
|
||||
| **Review architecture overview** | Before starting deployment | [Section 1-3](#1-what-this-architecture-is-and-is-not) — Understand what this architecture is, deployment mode, and high-level design |
|
||||
| **Complete preflight checklist** | **Before any infrastructure work** | [`PREFLIGHT.md`](./PREFLIGHT.md) — Verify prerequisites, permissions, and capacity |
|
||||
| **Follow deployment walkthrough** | After preflight passes | [`WALKTHROUGH.md`](./WALKTHROUGH.md) — Step-by-step deployment instructions |
|
||||
|
||||
### Architecture Reference
|
||||
|
||||
| What to Do | When to Do It | Where to Find Details |
|
||||
|------------|---------------|----------------------|
|
||||
| **Plan network topology** | During infrastructure design | [Section 4: Network & Ingress](#4-network--ingress) — VPC, subnets, ALB, and ingress requirements |
|
||||
| **Size compute resources** | During infrastructure design | [Section 5: Compute (EKS)](#5-compute-kubernetes-eks) — EKS cluster and node group sizing |
|
||||
| **Design data store architecture** | During infrastructure design | [Section 6: Data Stores](#6-data-stores) — PostgreSQL, Redis, and ClickHouse requirements |
|
||||
| **Review production requirements** | Before production deployment | [`PROD_CHECKLIST.md`](./PROD_CHECKLIST.md) — Detailed production capacity, topology, and scaling guidance |
|
||||
| **Configure object storage** | During infrastructure setup | [Section 7: Object Storage](#7-object-storage) — S3 bucket and access patterns |
|
||||
| **Plan secrets and authentication** | During infrastructure setup | [Section 8: Secrets & Identity](#8-secrets--identity) — Secrets management and auth patterns |
|
||||
|
||||
### Operations & Troubleshooting
|
||||
|
||||
| What to Do | When to Do It | Where to Find Details |
|
||||
|------------|---------------|----------------------|
|
||||
| **Understand operational patterns** | After deployment | [Section 8.5: Operational Guidance](#85-operational-guidance) — Ingestion configuration and failure modes |
|
||||
| **Set up observability** | During/after deployment | [Section 9: Observability](#9-observability-platform-level) — Logging and monitoring requirements |
|
||||
| **Review security baseline** | Before production | [Section 10: Security Baseline](#10-security-baseline-non-negotiable) — Required security controls |
|
||||
| **Troubleshoot issues** | When problems occur | [`TROUBLESHOOTING.md`](./TROUBLESHOOTING.md) — Common issues and diagnostic steps |
|
||||
|
||||
### Reference Information
|
||||
|
||||
| What to Do | When to Do It | Where to Find Details |
|
||||
|------------|---------------|----------------------|
|
||||
| **Understand what's excluded** | Before customizing | [Section 11: What's Excluded](#11-what-this-architecture-explicitly-excludes) — Out-of-scope features |
|
||||
| **Review design rationale** | For context | [Section 12: Why This Exists](#12-why-this-exists) — Purpose and goals of this architecture |
|
||||
|
||||
---
|
||||
|
||||
## 1. What This Architecture Is (and Is Not)
|
||||
|
||||
### This *is*:
|
||||
|
||||
Reference in New Issue
Block a user