Skip to content

Commit 2daca35

Browse files
aram356claude
andauthored
Fix dead links in ONBOARDING.md for VitePress build (#211)
Convert source file links to inline code format and root markdown file links to GitHub URLs, since VitePress cannot resolve paths outside its scope. Resolves: #210 Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 7390c17 commit 2daca35

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

docs/ONBOARDING.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -217,14 +217,14 @@ trusted-server/
217217

218218
### Key Files to Understand First
219219

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

229229
---
230230

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

363363
### Commit Message Format
364364

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

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

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

443443
### Modifying Request Routing
444444

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

447447
### Updating Configuration
448448

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

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

516516
### Key Contacts
517517

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

539539
### Documentation
540540

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

549549
### VitePress Documentation Site
550550

0 commit comments

Comments
 (0)