Skip to content

Commit 977708a

Browse files
docs: add quick wins reference documentation
Add four high-impact quick reference guides: - Integrations Overview: Comparison table of all built-in integrations (Prebid, Next.js, Permutive, Testlight) with features, endpoints, configuration examples, and use cases - API Reference: Complete endpoint catalog with request/response formats, query parameters, authentication, examples for all first-party, signing, TSJS, and integration endpoints - Environment Variables: Comprehensive guide to configuration via env vars including naming patterns, data type formats, secrets management, and complete examples for all integrations and settings - Error Reference: Common errors, causes, and solutions organized by category (configuration, runtime, integrations, signing, build/deploy) with debugging tips and troubleshooting steps Add new Reference section to sidebar with these guides for easy access
1 parent ace7f9e commit 977708a

File tree

6 files changed

+2177
-2
lines changed

6 files changed

+2177
-2
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Deploy VitePress Docs
22

33
on:
44
push:
5-
branches: [main, feature/docs-site]
5+
branches: [main]
66
paths:
77
- 'docs/**'
88
- '.github/workflows/deploy-docs.yml'

docs/.vitepress/config.mts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ export default defineConfig({
2727
{ text: 'GDPR Compliance', link: '/guide/gdpr-compliance' },
2828
{ text: 'Ad Serving', link: '/guide/ad-serving' },
2929
{ text: 'First-Party Proxy', link: '/guide/first-party-proxy' },
30-
{ text: 'Creative Processing', link: '/guide/creative-processing' }
30+
{ text: 'Creative Processing', link: '/guide/creative-processing' },
31+
{ text: 'Integrations Overview', link: '/guide/integrations-overview' }
3132
]
3233
},
3334
{
@@ -46,6 +47,14 @@ export default defineConfig({
4647
{ text: 'Testing', link: '/guide/testing' },
4748
{ text: 'Integration Guide', link: '/guide/integration-guide' }
4849
]
50+
},
51+
{
52+
text: 'Reference',
53+
items: [
54+
{ text: 'API Reference', link: '/guide/api-reference' },
55+
{ text: 'Environment Variables', link: '/guide/environment-variables' },
56+
{ text: 'Error Reference', link: '/guide/error-reference' }
57+
]
4958
}
5059
],
5160

0 commit comments

Comments
 (0)