Skip to content

docs: replace machine-local absolute paths with repo-relative links across all public docs #82

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

Merged
chrismaz11 merged 2 commits into from
Mar 24, 2026
Merged

docs: replace machine-local absolute paths with repo-relative links across all public docs #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b9c77f
Initial plan
Copilot Mar 24, 2026
ec84195
docs: replace machine-local absolute paths with repo-relative links i…
Copilot Mar 24, 2026
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
6 changes: 3 additions & 3 deletions COPYRIGHT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This repository is maintained as proprietary TrustSignal software and documentat

## Repository Consistency Rules

- Root ownership and license notices must remain consistent with the proprietary repository license in [`LICENSE`](/Users/christopher/Projects/TrustSignal/LICENSE).
- Root ownership and license notices must remain consistent with the proprietary repository license in [`LICENSE`](LICENSE).
- File-level license headers that conflict with the repository ownership position must be reviewed deliberately and documented before they are included in any ownership or registration claim.
- If a contribution was created with material AI assistance, external templates, copied snippets, contractor input, or third-party source material, that provenance must be recorded before the file is treated as a registration candidate.

Expand All @@ -31,10 +31,10 @@ The following categories are excluded from the initial copyright registration ca

## Open License Decision

- [`packages/contracts/contracts/AnchorRegistry.sol`](/Users/christopher/Projects/TrustSignal/packages/contracts/contracts/AnchorRegistry.sol) currently carries an `Apache-2.0` SPDX header.
- [`packages/contracts/contracts/AnchorRegistry.sol`](packages/contracts/contracts/AnchorRegistry.sol) currently carries an `Apache-2.0` SPDX header.
- That file must be treated as a deliberate license-decision item and excluded from the initial proprietary registration bundle until its licensing intent is explicitly resolved.

## Notices and Attribution

- If you add third-party code or assets, include any required attribution or notice material in [`NOTICE`](/Users/christopher/Projects/TrustSignal/NOTICE) or in file-level notices as appropriate.
- If you add third-party code or assets, include any required attribution or notice material in [`NOTICE`](NOTICE) or in file-level notices as appropriate.
- Do not remove or alter third-party license notices without confirming the applicable license obligations.
6 changes: 3 additions & 3 deletions bench/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ npx tsx bench/run-bench.ts --scenario batch --batch-size 10

The harness writes:

- [latest.json](/Users/christopher/Projects/trustsignal/bench/results/latest.json)
- [latest.md](/Users/christopher/Projects/trustsignal/bench/results/latest.md)
- [latest.json](bench/results/latest.json)
- [latest.md](bench/results/latest.md)
Comment on lines +34 to +35
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment on lines +34 to +35
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Drop redundant bench/ segment in benchmark artifact links

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 👍 / 👎.


The JSON contains raw timings plus aggregate metrics. The Markdown report is the public-safe evaluator summary for docs.

## Reproducibility Notes

- 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.
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- 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.

Copilot uses AI. Check for mistakes.
- Current metrics are local benchmark snapshots, not production guarantees.
14 changes: 7 additions & 7 deletions wiki/API-Overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,24 @@ Partners need a stable public contract that explains how TrustSignal fits into a

## 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).
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.

TrustSignal exposes a public verification lifecycle centered on signed verification receipts, verification signals, verifiable provenance metadata, and later verification.

## Demo

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)
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- [5-minute developer trial](demo/README.md)
- [5-minute developer trial](../demo/README.md)

Copilot uses AI. Check for mistakes.

## Integration Model

Start here to try the public lifecycle:

- [OpenAPI contract](/Users/christopher/Projects/trustsignal/openapi.yaml)
- [Evaluator quickstart](/Users/christopher/Projects/trustsignal/docs/partner-eval/quickstart.md)
- [API playground](/Users/christopher/Projects/trustsignal/docs/partner-eval/api-playground.md)
- [Postman collection](/Users/christopher/Projects/trustsignal/postman/TrustSignal.postman_collection.json)
- [OpenAPI contract](openapi.yaml)
- [Evaluator quickstart](docs/partner-eval/quickstart.md)
- [API playground](docs/partner-eval/api-playground.md)
- [Postman collection](postman/TrustSignal.postman_collection.json)
Comment on lines +34 to +37
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These links are in wiki/API-Overview.md, so openapi.yaml, docs/..., and postman/... resolve under wiki/ on GitHub and will 404. Update them to be relative to wiki/ (e.g., ../openapi.yaml, ../docs/..., ../postman/...).

Copilot uses AI. Check for mistakes.

Golden path:

Expand Down Expand Up @@ -103,4 +103,4 @@ Integrators should expect these broad patterns:
- `429` for rate limiting
- `503` when a required dependency is unavailable

The canonical public contract for the verification lifecycle is [openapi.yaml](/Users/christopher/Projects/trustsignal/openapi.yaml).
The canonical public contract for the verification lifecycle is [openapi.yaml](openapi.yaml).
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this file lives under wiki/, linking to openapi.yaml resolves to wiki/openapi.yaml on GitHub and will 404. Use ../openapi.yaml (or a GitHub blob URL) instead.

Suggested change
The canonical public contract for the verification lifecycle is [openapi.yaml](openapi.yaml).
The canonical public contract for the verification lifecycle is [openapi.yaml](../openapi.yaml).

Copilot uses AI. Check for mistakes.
10 changes: 5 additions & 5 deletions wiki/Home.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ High-loss environments create incentives for these attack paths because downstre

## 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).
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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).

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Prefix wiki links with ../ to reach repo-root docs

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 👍 / 👎.


TrustSignal provides signed verification receipts, verification signals, verifiable provenance metadata, and later verification capability as an integrity layer for an existing system of record.

Expand All @@ -35,15 +35,15 @@ TrustSignal provides signed verification receipts, verification signals, verifia

## Demo

- [5-minute developer trial](/Users/christopher/Projects/trustsignal/demo/README.md)
- [5-minute developer trial](demo/README.md)
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- [5-minute developer trial](demo/README.md)
- [5-minute developer trial](../demo/README.md)

Copilot uses AI. Check for mistakes.

## Integration Model

Use the evaluator docs when you want to see the verification lifecycle before production integration detail:

- [Evaluator quickstart](/Users/christopher/Projects/trustsignal/docs/partner-eval/quickstart.md)
- [API playground](/Users/christopher/Projects/trustsignal/docs/partner-eval/api-playground.md)
- [OpenAPI contract](/Users/christopher/Projects/trustsignal/openapi.yaml)
- [Evaluator quickstart](docs/partner-eval/quickstart.md)
- [API playground](docs/partner-eval/api-playground.md)
- [OpenAPI contract](openapi.yaml)
Comment on lines +44 to +46
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copilot uses AI. Check for mistakes.

## Technical Details

Expand Down
10 changes: 5 additions & 5 deletions wiki/Quick-Verification-Example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@ This example is for partner engineers who want the smallest realistic TrustSigna

## 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).
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.

This example uses the current integration-facing lifecycle to create a verification, return verification signals plus a signed verification receipt, store the receipt with the workflow record, and later verify stored receipt state during audit review.

## Demo

Start here for the full evaluator path:

- [Evaluator quickstart](/Users/christopher/Projects/trustsignal/docs/partner-eval/quickstart.md)
- [API playground](/Users/christopher/Projects/trustsignal/docs/partner-eval/api-playground.md)
- [OpenAPI contract](/Users/christopher/Projects/trustsignal/openapi.yaml)
- [Postman collection](/Users/christopher/Projects/trustsignal/postman/TrustSignal.postman_collection.json)
- [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)
Comment on lines +28 to +31
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.

## Integration Model

Expand Down
2 changes: 1 addition & 1 deletion wiki/What-is-TrustSignal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ TrustSignal is evidence integrity infrastructure. It provides signed verificatio

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)
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- [5-minute developer trial](demo/README.md)
- [5-minute developer trial](../demo/README.md)

Copilot uses AI. Check for mistakes.

## Integration

Expand Down
Loading