docs: replace machine-local absolute paths with repo-relative links across all public docs#82
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…n wiki and bench docs Co-authored-by: chrismaz11 <24700273+chrismaz11@users.noreply.github.com> Agent-Logs-Url: https://github.com/TrustSignal-dev/TrustSignal/sessions/bf2e134e-e0c8-4162-8f44-c3995f80bf2f
There was a problem hiding this comment.
Pull request overview
This PR removes remaining machine-local absolute documentation links (/Users/christopher/Projects/...) from multiple public-facing Markdown files, intending to make links portable and render correctly on GitHub.
Changes:
- Replaced machine-local absolute paths with repo-relative links across
wiki/*.md,bench/README.md, andCOPYRIGHT.md. - Standardized link targets to point at repo artifacts like
docs/,demo/,openapi.yaml,postman/,bench/results/, andbench/fixtures.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| wiki/API-Overview.md | Replaces absolute paths with repo-relative links for lifecycle/docs/demo/OpenAPI/Postman references. |
| wiki/Home.md | Replaces absolute paths with repo-relative links for lifecycle/docs/demo/OpenAPI references. |
| wiki/Quick-Verification-Example.md | Replaces absolute paths with repo-relative links for lifecycle/docs/OpenAPI/Postman references. |
| wiki/What-is-TrustSignal.md | Replaces absolute path with repo-relative link to the developer trial/demo. |
| bench/README.md | Replaces absolute paths with repo-relative links to bench outputs and fixtures. |
| COPYRIGHT.md | Replaces absolute paths with repo-relative links to LICENSE/NOTICE and a contracts file. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Demo | ||
|
|
||
| - [5-minute developer trial](/Users/christopher/Projects/trustsignal/demo/README.md) | ||
| - [5-minute developer trial](demo/README.md) |
There was a problem hiding this comment.
This wiki page lives under wiki/, so this link currently resolves to wiki/demo/README.md on GitHub. Update it to a path relative to wiki/ (e.g., ../demo/README.md) so it resolves correctly.
| - [5-minute developer trial](demo/README.md) | |
| - [5-minute developer trial](../demo/README.md) |
| - [Evaluator quickstart](docs/partner-eval/quickstart.md) | ||
| - [API playground](docs/partner-eval/api-playground.md) | ||
| - [OpenAPI contract](openapi.yaml) |
There was a problem hiding this comment.
These links are in wiki/Home.md, so docs/... and openapi.yaml will be resolved under wiki/ (e.g., wiki/docs/...) and 404. Update them to be relative to wiki/ (e.g., ../docs/..., ../openapi.yaml).
| ## Verification Lifecycle | ||
|
|
||
| The canonical lifecycle diagram is documented in [docs/verification-lifecycle.md](/Users/christopher/Projects/trustsignal/docs/verification-lifecycle.md). | ||
| The canonical lifecycle diagram is documented in [docs/verification-lifecycle.md](docs/verification-lifecycle.md). |
There was a problem hiding this comment.
Because this file is in wiki/, this link resolves to wiki/docs/verification-lifecycle.md on GitHub. Update to a path relative to wiki/ (e.g., ../docs/verification-lifecycle.md) so it doesn’t 404.
| Start with the local developer trial for the fastest lifecycle walkthrough: | ||
|
|
||
| - [5-minute developer trial](/Users/christopher/Projects/trustsignal/demo/README.md) | ||
| - [5-minute developer trial](demo/README.md) |
There was a problem hiding this comment.
This page is under wiki/, so this link currently resolves to wiki/demo/README.md on GitHub. Update it to be relative to wiki/ (e.g., ../demo/README.md) so it resolves correctly.
| - [5-minute developer trial](demo/README.md) | |
| - [5-minute developer trial](../demo/README.md) |
| ## Verification Lifecycle | ||
|
|
||
| The canonical lifecycle diagram is documented in [docs/verification-lifecycle.md](/Users/christopher/Projects/trustsignal/docs/verification-lifecycle.md). | ||
| The canonical lifecycle diagram is documented in [docs/verification-lifecycle.md](docs/verification-lifecycle.md). |
There was a problem hiding this comment.
Because this file is in wiki/, linking to docs/verification-lifecycle.md will resolve to wiki/docs/verification-lifecycle.md and likely 404. Update the link to be relative to wiki/ (e.g., ../docs/verification-lifecycle.md) or use a GitHub blob URL.
| - [latest.json](bench/results/latest.json) | ||
| - [latest.md](bench/results/latest.md) |
There was a problem hiding this comment.
This README is in the bench/ directory, so linking to bench/results/... resolves to bench/bench/results/... on GitHub. Use a path relative to bench/ (e.g., results/latest.json and results/latest.md) so the links resolve.
| - The harness starts a temporary local PostgreSQL instance and tears it down after the run. | ||
| - It targets the real local `/api/v1/*` evaluator routes through Fastify injection, so it exercises the same request validation, auth checks, persistence, receipt issuance, and later-verification logic used by the current evaluator path. | ||
| - It uses local fixture artifacts from [bench/fixtures](/Users/christopher/Projects/trustsignal/bench/fixtures) to keep clean and tampered runs deterministic. | ||
| - It uses local fixture artifacts from [bench/fixtures](bench/fixtures) to keep clean and tampered runs deterministic. |
There was a problem hiding this comment.
Because this file is in bench/, linking to bench/fixtures resolves to bench/bench/fixtures on GitHub. Use fixtures (relative to bench/) so the link resolves.
| - It uses local fixture artifacts from [bench/fixtures](bench/fixtures) to keep clean and tampered runs deterministic. | |
| - It uses local fixture artifacts from [fixtures](fixtures) to keep clean and tampered runs deterministic. |
| The fastest local evaluator path is the 5-minute developer trial: | ||
|
|
||
| - [5-minute developer trial](/Users/christopher/Projects/trustsignal/demo/README.md) | ||
| - [5-minute developer trial](demo/README.md) |
There was a problem hiding this comment.
These wiki pages live under wiki/, so this repo-relative link resolves to wiki/demo/README.md on GitHub and will 404. Use a path relative to wiki/ (e.g., ../demo/README.md) or a fully qualified GitHub blob link so it resolves correctly.
| - [5-minute developer trial](demo/README.md) | |
| - [5-minute developer trial](../demo/README.md) |
| - [Evaluator quickstart](docs/partner-eval/quickstart.md) | ||
| - [API playground](docs/partner-eval/api-playground.md) | ||
| - [OpenAPI contract](openapi.yaml) | ||
| - [Postman collection](postman/TrustSignal.postman_collection.json) |
There was a problem hiding this comment.
These links are in a file under wiki/, so docs/..., openapi.yaml, and postman/... resolve under wiki/ on GitHub. Update them to be relative to wiki/ (e.g., ../docs/..., ../openapi.yaml, ../postman/...) so they don’t 404.
| ## Verification Lifecycle | ||
|
|
||
| The canonical lifecycle diagram is documented in [docs/verification-lifecycle.md](/Users/christopher/Projects/trustsignal/docs/verification-lifecycle.md). | ||
| The canonical lifecycle diagram is documented in [docs/verification-lifecycle.md](docs/verification-lifecycle.md). |
There was a problem hiding this comment.
Because this file is in wiki/, this repo-relative link resolves to wiki/docs/verification-lifecycle.md on GitHub and will 404. Use a path relative to wiki/ (e.g., ../docs/verification-lifecycle.md) or a GitHub blob URL.
| The canonical lifecycle diagram is documented in [docs/verification-lifecycle.md](docs/verification-lifecycle.md). | |
| The canonical lifecycle diagram is documented in [docs/verification-lifecycle.md](../docs/verification-lifecycle.md). |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ec841953f1
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ## Verification Lifecycle | ||
|
|
||
| The canonical lifecycle diagram is documented in [docs/verification-lifecycle.md](/Users/christopher/Projects/trustsignal/docs/verification-lifecycle.md). | ||
| The canonical lifecycle diagram is documented in [docs/verification-lifecycle.md](docs/verification-lifecycle.md). |
There was a problem hiding this comment.
Links in files under wiki/ are resolved relative to that directory, so targets like docs/verification-lifecycle.md, demo/README.md, and openapi.yaml now point to nonexistent wiki/docs/..., wiki/demo/..., and wiki/openapi.yaml paths. This commit therefore leaves the primary navigation links broken in rendered wiki pages/repo markdown, and they should be rewritten with parent-relative paths (for example ../docs/...) so readers can reach the intended repo-root files.
Useful? React with 👍 / 👎.
| - [latest.json](bench/results/latest.json) | ||
| - [latest.md](bench/results/latest.md) |
There was a problem hiding this comment.
Because bench/README.md already lives inside bench/, links like bench/results/latest.json and bench/fixtures resolve to bench/bench/results/... and bench/bench/fixtures, which do not exist. This breaks the documented output and fixture references for anyone reading the benchmark docs; these targets should be relative to the current directory (for example results/latest.json and fixtures).
Useful? React with 👍 / 👎.
Machine-local absolute paths (
/Users/christopher/Projects/trustsignal/...) remained in six public-facing files after theREADME.mdfix in #71. This PR replaces them with repo-relative links matching the pattern already established inREADME.md.Summary
wiki/API-Overview.md— 7 links fixed (lifecycle diagram, demo, OpenAPI, evaluator quickstart, API playground, Postman collection)wiki/Home.md— 5 links fixed (lifecycle diagram, demo, evaluator quickstart, API playground, OpenAPI)wiki/Quick-Verification-Example.md— 5 links fixed (lifecycle diagram, evaluator quickstart, API playground, OpenAPI, Postman)wiki/What-is-TrustSignal.md— 1 link fixed (demo)bench/README.md— 3 links fixed (latest.json,latest.md,bench/fixtures)COPYRIGHT.md— 3 links fixed (LICENSE,AnchorRegistry.sol,NOTICE)AI Disclosure (optional)
Review Checklist
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.