Skip to content

Commit 7b709c4

Browse files
docs: Adding redirects (#3965)
Signed-off-by: Andrew Schilling <[email protected]>
1 parent d9e8d33 commit 7b709c4

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

docs/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,12 @@ This approach is ideal for CI/CD pipelines or when you want complete isolation f
6868
- `docs/_extensions/` - Custom Sphinx extensions
6969
- `docs/build/` - Generated documentation output (not tracked in git)
7070

71+
## Redirect Creation
72+
73+
When moving or renaming files a redirect must be created.
74+
75+
Redirect entries should be added to the `redirects` dictionary in `conf.py`. For detailed information on redirect syntax, see the [sphinx-reredirects usage documentation](https://documatt.com/sphinx-reredirects/usage/#introduction).
76+
7177
## Dependency Management
7278

7379
Documentation dependencies are defined in `pyproject.toml` under the `[dependency-groups]` section:

docs/conf.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,23 @@
3333
"sphinx_reredirects",
3434
]
3535

36+
# Redirects configuration
37+
redirects = {
38+
"guides/tool-calling": "../agents/tool-calling.html", # key format corrected
39+
"architecture/architecture": "../design_docs/architecture.html",
40+
"architecture/disagg_serving": "../design_docs/disagg_serving.html",
41+
"architecture/distributed_runtime": "../design_docs/distributed_runtime.html",
42+
"architecture/dynamo_flow": "../design_docs/dynamo_flow.html",
43+
"architecture/request_cancellation": "../fault_tolerance/request_cancellation.html",
44+
"architecture/request_migration": "../fault_tolerance/request_migration.html",
45+
"kubernetes/create_deployment": "../kubernetes/deployment/create_deployment.html",
46+
"kubernetes/minikube": "../kubernetes/deployment/minikube.html",
47+
"kubernetes/multinode-deployment": "../kubernetes/deployment/multinode-deployment.html",
48+
"kubernetes/logging": "../kubernetes/observability/logging.html",
49+
"kubernetes/metrics": "../kubernetes/observability/metrics.html",
50+
"architecture/kv_cache_routing": "../router/kv_cache_routing.html",
51+
}
52+
3653
# Custom extensions
3754
sys.path.insert(0, os.path.abspath("_extensions"))
3855
extensions.append("github_alerts")

0 commit comments

Comments
 (0)