Skip to content

Commit bb754f0

Browse files
authored
docs: rewrite landing page (#60)
1 parent 9b88c8e commit bb754f0

15 files changed

Lines changed: 279 additions & 29 deletions

AGENTS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -826,6 +826,10 @@ helm uninstall observability-stack-test
826826
- Provide both quick start and detailed explanations
827827
- Include troubleshooting sections
828828

829+
### Icons
830+
831+
Use OpenSearch UI (OUI) icons for documentation components. Browse the full set at https://oui.opensearch.org/1.23/#/display/icons. SVG sources are at https://github.com/opensearch-project/oui/tree/main/src/components/icon/assets. Prefer 32x32 icons over 16x16 for consistent sizing.
832+
829833
### Examples
830834

831835
- Include complete, runnable code

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md
Lines changed: 7 additions & 0 deletions
Loading

docs/starlight-docs/astro.config.mjs

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,53 +16,75 @@ export default defineConfig({
1616
logo: {
1717
src: './src/assets/opensearch-logo-darkmode.svg',
1818
},
19+
editLink: {
20+
baseUrl: 'https://github.com/opensearch-project/observability-stack/edit/main/docs/starlight-docs/',
21+
},
22+
customCss: [
23+
'./src/styles/custom.css',
24+
],
1925
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/opensearch-project/observability-stack' }],
2026
components: {
2127
Header: './src/components/CustomHeader.astro',
28+
PageSidebar: './src/components/PageSidebar.astro',
2229
},
2330
sidebar: [
31+
{
32+
label: 'Overview',
33+
link: '/',
34+
},
2435
{
2536
label: 'Get Started',
37+
collapsed: true,
2638
autogenerate: { directory: 'get-started' },
2739
},
2840
{
2941
label: 'Send Data',
42+
collapsed: true,
3043
autogenerate: { directory: 'send-data' },
3144
},
3245
{
3346
label: 'Investigate',
47+
collapsed: true,
3448
autogenerate: { directory: 'investigate' },
3549
},
3650
{
3751
label: 'Application Monitoring',
52+
collapsed: true,
3853
autogenerate: { directory: 'apm' },
3954
},
4055
{
4156
label: 'Dashboards & Visualize',
57+
collapsed: true,
4258
autogenerate: { directory: 'dashboards' },
4359
},
4460
{
4561
label: 'AI Observability',
62+
collapsed: true,
4663
autogenerate: { directory: 'ai-observability' },
4764
},
4865
{
4966
label: 'MCP Server',
67+
collapsed: true,
5068
autogenerate: { directory: 'mcp' },
5169
},
5270
{
5371
label: 'Alerting',
72+
collapsed: true,
5473
autogenerate: { directory: 'alerting' },
5574
},
5675
{
5776
label: 'Anomaly Detection',
77+
collapsed: true,
5878
autogenerate: { directory: 'anomaly-detection' },
5979
},
6080
{
6181
label: 'Forecasting',
82+
collapsed: true,
6283
autogenerate: { directory: 'forecasting' },
6384
},
6485
{
6586
label: 'SDKs & API',
87+
collapsed: true,
6688
autogenerate: { directory: 'sdks' },
6789
},
6890
],
Lines changed: 17 additions & 0 deletions
Loading
Lines changed: 19 additions & 0 deletions
Loading
Lines changed: 17 additions & 0 deletions
Loading
Lines changed: 20 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)