Skip to content

Fix dead links in ONBOARDING.md for VitePress build #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aram356 wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −20
Open

Fix dead links in ONBOARDING.md for VitePress build #211

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 20 additions & 20 deletions docs/ONBOARDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,14 +217,14 @@ trusted-server/

### Key Files to Understand First

| File | Purpose |
| ------------------------------------------------------------------------------------------- | ----------------------------------------- |
| [crates/fastly/src/main.rs](../crates/fastly/src/main.rs) | Request routing entry point - start here! |
| [crates/common/src/publisher.rs](../crates/common/src/publisher.rs) | Publisher origin handling |
| [crates/common/src/proxy.rs](../crates/common/src/proxy.rs) | First-party proxy implementation |
| [crates/common/src/synthetic.rs](../crates/common/src/synthetic.rs) | Synthetic ID generation |
| [crates/common/src/integrations/registry.rs](../crates/common/src/integrations/registry.rs) | Integration module pattern |
| [trusted-server.toml](../trusted-server.toml) | Application configuration |
| File | Purpose |
| ------------------------------------------ | ----------------------------------------- |
| `crates/fastly/src/main.rs` | Request routing entry point - start here! |
| `crates/common/src/publisher.rs` | Publisher origin handling |
| `crates/common/src/proxy.rs` | First-party proxy implementation |
| `crates/common/src/synthetic.rs` | Synthetic ID generation |
| `crates/common/src/integrations/registry.rs` | Integration module pattern |
| `trusted-server.toml` | Application configuration |

---

Expand Down Expand Up @@ -357,12 +357,12 @@ cargo test
1. Create a feature branch from `main`
2. Make your changes
3. Run `cargo fmt`, `cargo clippy`, and `cargo test`
4. Commit using the guidelines in [CONTRIBUTING.md](../CONTRIBUTING.md#memo-writing-commit-messages)
4. Commit using the guidelines in [CONTRIBUTING.md](https://github.com/IABTechLab/trusted-server/blob/main/CONTRIBUTING.md)
5. Open a Pull Request

### Commit Message Format

Follow the guidelines in [CONTRIBUTING.md](../CONTRIBUTING.md#memo-writing-commit-messages). In short:
Follow the guidelines in [CONTRIBUTING.md](https://github.com/IABTechLab/trusted-server/blob/main/CONTRIBUTING.md). In short:

- Use sentence case and imperative mood
- Do not use semantic prefixes or bracketed tags (examples: `fix:`, `[Docs]`)
Expand Down Expand Up @@ -438,11 +438,11 @@ fastly compute serve
4. Add configuration in `trusted-server.toml`
5. Write tests

See [testlight.rs](../crates/common/src/integrations/testlight.rs) for an example.
See `crates/common/src/integrations/testlight.rs` for an example.

### Modifying Request Routing

Edit [crates/fastly/src/main.rs](../crates/fastly/src/main.rs) to add new routes or modify existing ones.
Edit `crates/fastly/src/main.rs` to add new routes or modify existing ones.

### Updating Configuration

Expand Down Expand Up @@ -511,7 +511,7 @@ The project follows IAB Tech Lab's open-source governance model:
| Project Lead | Overall project vision and direction |
| Developer | Contributes code/docs |

See [ProjectGovernance.md](../ProjectGovernance.md) for full details.
See [ProjectGovernance.md](https://github.com/IABTechLab/trusted-server/blob/main/ProjectGovernance.md) for full details.

### Key Contacts

Expand All @@ -538,13 +538,13 @@ Ask your manager or onboarding buddy for calendar invites to relevant meetings.

### Documentation

| Resource | Description |
| ------------------------------------- | --------------------------------------------- |
| [README.md](../README.md) | Project overview and setup |
| [CONTRIBUTING.md](../CONTRIBUTING.md) | Contribution guidelines |
| [AGENTS.md](../AGENTS.md) | AI assistant guidance / architecture overview |
| [SEQUENCE.md](../SEQUENCE.md) | Request flow diagrams |
| [FAQ_POC.md](../FAQ_POC.md) | Frequently asked questions |
| Resource | Description |
| ------------------------------------------------------------------------------------------- | --------------------------------------------- |
| [README.md](https://github.com/IABTechLab/trusted-server/blob/main/README.md) | Project overview and setup |
| [CONTRIBUTING.md](https://github.com/IABTechLab/trusted-server/blob/main/CONTRIBUTING.md) | Contribution guidelines |
| [AGENTS.md](https://github.com/IABTechLab/trusted-server/blob/main/AGENTS.md) | AI assistant guidance / architecture overview |
| [SEQUENCE.md](https://github.com/IABTechLab/trusted-server/blob/main/SEQUENCE.md) | Request flow diagrams |
| [FAQ_POC.md](https://github.com/IABTechLab/trusted-server/blob/main/FAQ_POC.md) | Frequently asked questions |

### VitePress Documentation Site

Expand Down