Skip to content

Commit e678dba

Browse files
committed
Fix architecture pages to appear in sidebar TOC hierarchy
Create how-it-works/index.rst as a parent container with toctree so that Architecture and Open Source vs SaaS pages appear nested under "Overview" in the sidebar, matching the pattern used by GitOps > ArgoCD. Previously they were listed flat as orphan pages. https://claude.ai/code/session_0184fwhrjC4ELrYQBMCbyhfS
1 parent f3dfb0e commit e678dba

3 files changed

Lines changed: 31 additions & 4 deletions

File tree

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@
109109
"tutorials/routing-silencing.html": "/master/notification-routing/routing-silencing.html",
110110
"configuration/configuring-sinks.html": "/master/notification-routing/configuring-sinks.html",
111111
"how-it-works/privacy-and-security.html": "/master/setup-robusta/privacy-and-security.html",
112-
"how-it-works/index.html": "/master/playbook-reference/what-are-playbooks.html",
112+
# "how-it-works/index.html": "/master/playbook-reference/what-are-playbooks.html", # removed: now a real page
113113
"playbook-reference/examples.html": "/master/playbook-reference/builtin-alert-enrichment.html",
114114
"playbook-reference/prometheus-examples/index.html": "/master/playbook-reference/builtin-alert-enrichment.html",
115115
"tutorials/playbook-track-changes.html": "/master/playbook-reference/kubernetes-examples/kubernetes-change-notifications.html",

docs/how-it-works/index.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
:hide-toc:
2+
3+
Overview
4+
====================
5+
6+
.. grid:: 1 1 2 3
7+
:gutter: 2
8+
9+
.. grid-item-card:: :octicon:`cpu;1em;` Architecture
10+
:class-card: sd-bg-text-light
11+
:link: architecture
12+
:link-type: doc
13+
14+
How Robusta's components work together — the Agent, HolmesGPT, data sources, and the Platform.
15+
16+
.. grid-item-card:: :octicon:`package;1em;` Open Source vs SaaS
17+
:class-card: sd-bg-light sd-bg-text-light
18+
:link: oss-vs-saas
19+
:link-type: doc
20+
21+
Compare deployment options: open source HolmesGPT, SaaS, and self-hosted.
22+
23+
.. toctree::
24+
:maxdepth: 1
25+
:hidden:
26+
27+
Architecture <architecture>
28+
Open Source vs SaaS <oss-vs-saas>

docs/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
:hide-toc:
22

33
.. toctree::
4-
:maxdepth: 1
4+
:maxdepth: 4
55
:caption: Overview
66
:hidden:
77

88
self
9-
how-it-works/architecture
10-
how-it-works/oss-vs-saas
9+
how-it-works/index
1110

1211
.. toctree::
1312
:maxdepth: 4

0 commit comments

Comments
 (0)