Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ export default withMermaid(
description:
'Edge computing for ad serving, consent signal handling, and edge cookie (EC) generation',
base: '/trusted-server',
srcExclude: [
'superpowers/**',
'internal/**',
'epics/**',
'guide/onboarding.md',
'README.md',
'business-use-cases.md',
],

// Replace version placeholders like {{NODEJS_VERSION}} with values from .tool-versions
markdown: {
Expand All @@ -58,8 +66,7 @@ export default withMermaid(
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Home', link: '/' },
{ text: 'Guide', link: '/guide/getting-started' },
{ text: 'Business Value', link: '/business-use-cases' },
{ text: 'Guide', link: '/guide/' },
{ text: 'Roadmap', link: '/roadmap' },
],

Expand Down
30 changes: 30 additions & 0 deletions docs/guide/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Guide

Use these guides to understand Trusted Server, configure a deployment, and
contribute to the project.

## Start here

- [What is Trusted Server?](/guide/what-is-trusted-server)
- [Getting Started](/guide/getting-started)

## Core concepts

- [Edge Cookies](/guide/edge-cookies)
- [GDPR Compliance](/guide/gdpr-compliance)
- [Ad Serving](/guide/ad-serving)
- [First-Party Proxy](/guide/first-party-proxy)
- [Asset Routes](/guide/asset-routes)

## Development

- [Architecture](/guide/architecture)
- [Configuration](/guide/configuration)
- [CLI](/guide/cli)
- [Testing](/guide/testing)
- [Integration Guide](/guide/integration-guide)

## Reference

- [API Reference](/guide/api-reference)
- [Error Reference](/guide/error-reference)
160 changes: 0 additions & 160 deletions docs/guide/onboarding.md

This file was deleted.

42 changes: 42 additions & 0 deletions docs/internal/onboarding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Maintainer Onboarding

This document collects public repository and setup pointers for maintainers.
For project usage, start with the public guides.

## Start here

- [What is Trusted Server?](../guide/what-is-trusted-server.md)
- [Architecture](../guide/architecture.md)
- [Getting Started](../guide/getting-started.md)
- [Configuration](../guide/configuration.md)
- [Testing](../guide/testing.md)
- [Integrations Overview](../guide/integrations-overview.md)
- [Integration Guide](../guide/integration-guide.md)

## Local setup

- Tool versions are defined in `.tool-versions`.
- Documentation development instructions are in `docs/README.md`.
- Contribution requirements are in
[CONTRIBUTING.md](https://github.com/IABTechLab/trusted-server/blob/main/CONTRIBUTING.md).

## Codebase pointers

| Path | Purpose |
| --------------------------------------------------------- | --------------------------------- |
| `crates/trusted-server-adapter-fastly/src/main.rs` | Request routing entry point |
| `crates/trusted-server-core/src/publisher.rs` | Publisher origin handling |
| `crates/trusted-server-core/src/proxy.rs` | First-party proxy implementation |
| `crates/trusted-server-core/src/ec/` | EC identity subsystem |
| `crates/trusted-server-core/src/integrations/registry.rs` | Integration module registry |
| `trusted-server.example.toml` | Example application configuration |

## Development workflow

- Follow [CONTRIBUTING.md](https://github.com/IABTechLab/trusted-server/blob/main/CONTRIBUTING.md)
when preparing changes.
- Use the [Testing guide](../guide/testing.md) for test commands.
- Use the [Integration Guide](../guide/integration-guide.md) when adding an
integration.
- Report bugs and request changes through the repository's public
[GitHub issues](https://github.com/IABTechLab/trusted-server/issues).
Loading