Skip to content

Commit 00f15d4

Browse files
authored
Merge pull request #15 from WithAutonomi/chore/transfer-to-withautonomi
Use WithAutonomi as the canonical documentation source
2 parents 645012f + 2f8ec14 commit 00f15d4

11 files changed

Lines changed: 99 additions & 16 deletions

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ When adding or updating a whitepaper:
104104

105105
The Worker does not currently serve `.pdf` files from `autonomi.com`. Whitepaper PDF links should use explicit GitHub raw URLs, for example:
106106

107-
`https://raw.githubusercontent.com/maidsafe/autonomi-llm-docs/main/whitepapers/Autonomous-Network.pdf`
107+
`https://raw.githubusercontent.com/WithAutonomi/autonomi-llm-docs/main/whitepapers/Autonomous-Network.pdf`
108108

109109
Do not use relative PDF links such as `Autonomous-Network.pdf` from a served Markdown page, because that would resolve against `autonomi.com` and fall through to Framer rather than serving the file from this repo.
110110

@@ -146,7 +146,7 @@ Serving-policy changes should be reflected in Worker tests and checked against A
146146

147147
## Contributing
148148

149-
This repo is maintained by the MaidSafe team. Content should be:
149+
This repo is maintained by the Autonomi team. Content should be:
150150

151151
- Written in clear, accessible markdown
152152
- Comprehensive enough for AI assistants to guide developers and inform those wishing to understand the technology

docs/adr/ADR-0004-serve-pdfs-from-github-raw.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@
66
- **Reviewers:** Jim Collinson (retrospective — author attestation)
77
- **Supersedes:** none
88
- **Superseded by:** none
9-
- **Related:** ADR-0002 (Worker/GitHub serving); ADR-0003 (`llms.txt`)
9+
- **Related:** ADR-0002 (Worker/GitHub serving); ADR-0003 (`llms.txt`); ADR-0007 (repository transfer)
1010

11-
> **Retrospective ADR.** This record reconstructs a decision made earlier in development, before the ADR process existed in this repo. It is backfilled and proposed on 2026-06-24 (accepted on merge of this PR), on the basis of the decision owner's attestation and direct inspection of the deployed system; it was not produced by contemporaneous review.
11+
> **Retrospective ADR.** This record reconstructs a decision made earlier in development, before the ADR process existed in this repo. It is backfilled and proposed on 2026-06-24, on the basis of the decision owner's attestation and direct inspection of the deployed system; it was not produced by contemporaneous review.
1212
1313
## Context
1414

1515
The foundational MaidSafe whitepapers are published in two forms in this repo: a Markdown conversion (machine-readable, served at `autonomi.com/whitepapers/<paper>.md`) and the original PDF (the authoritative, citable artefact for humans). The decision to keep both forms is editorial/content and is not the subject of this ADR.
1616

17+
The planned repository transfer in ADR-0007 prompted this Proposed ADR to use the destination `WithAutonomi` owner namespace for current raw URLs. That namespace update does not change the direct-GitHub-raw serving decision recorded here.
18+
1719
The architectural question this ADR settles is narrower: **how should the PDF be addressed in a link, given how the serving pipeline works?** The Cloudflare Worker (ADR-0002) intercepts only `.md`, `/llms.txt`, and `/llms-full.txt`. It has no behaviour for `.pdf` requests, so a PDF path under `autonomi.com` is not served from the repo — it falls through to Framer, where the file does not exist. Therefore a relative sibling link (`<paper>.pdf`) or an apex link (`autonomi.com/whitepapers/<paper>.pdf`) from within a served Markdown page would not resolve to the PDF in the repo.
1820

1921
## Decision Drivers
@@ -31,9 +33,9 @@ The architectural question this ADR settles is narrower: **how should the PDF be
3133

3234
## Decision
3335

34-
Whitepaper Markdown pages link to their PDF using an explicit `raw.githubusercontent.com` URL pointing at the file in `maidsafe/autonomi-llm-docs` (branch `main`), rather than a relative sibling path or an `autonomi.com` apex path. This is because the Worker does not intercept `.pdf` requests, so only a direct GitHub-raw URL resolves to the actual file.
36+
Whitepaper Markdown pages link to their PDF using an explicit `raw.githubusercontent.com` URL pointing at the file in `WithAutonomi/autonomi-llm-docs` (branch `main`), rather than a relative sibling path or an `autonomi.com` apex path. This is because the Worker does not intercept `.pdf` requests, so only a direct GitHub-raw URL resolves to the actual file.
3537

36-
Example (verified live 2026-06-24): `autonomi.com/whitepapers/autonomous-network.md` links its PDF as `https://raw.githubusercontent.com/maidsafe/autonomi-llm-docs/main/whitepapers/Autonomous-Network.pdf`.
38+
Post-transfer example: `autonomi.com/whitepapers/autonomous-network.md` links its PDF as `https://raw.githubusercontent.com/WithAutonomi/autonomi-llm-docs/main/whitepapers/Autonomous-Network.pdf`.
3739

3840
If the Worker is later extended to serve PDFs from GitHub under apex URLs, this ADR should be superseded and the links migrated to canonical `autonomi.com` paths.
3941

@@ -58,7 +60,7 @@ If the Worker is later extended to serve PDFs from GitHub under apex URLs, this
5860

5961
## Validation
6062

61-
- The PDF link in `autonomi.com/whitepapers/autonomous-network.md` is a `raw.githubusercontent.com` URL and downloads the correct file (verified 2026-06-24).
63+
- After the ADR-0007 transfer and namespace migration, the PDF link in `autonomi.com/whitepapers/autonomous-network.md` is a `raw.githubusercontent.com` URL under `WithAutonomi/autonomi-llm-docs` and downloads the correct file.
6264
- Review trigger: any change to Worker PDF behaviour, or to where the PDFs are hosted, or a rename of the repo/branch, requires revisiting this ADR.
6365

6466
## Notes for AI-assisted work
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# ADR-0007: Transfer repository ownership to WithAutonomi
2+
3+
- **Status:** Accepted
4+
- **Date:** 2026-08-04
5+
- **Decision owners:** Jim Collinson
6+
- **Reviewers:** Jim Collinson
7+
- **Supersedes:** none
8+
- **Superseded by:** none
9+
- **Related:** ADR-0002 (Worker/GitHub serving); ADR-0004 (PDF serving); ADR-0005 (Worker source management); repository-transfer implementation PR
10+
11+
## Context
12+
13+
This repository contains Autonomi's machine-readable documentation and the source and deployment configuration for the Cloudflare Worker that serves it at `autonomi.com`. It currently belongs to the MaidSafe GitHub organization, while current ownership, access, and operational responsibility sit with the Autonomi team in the WithAutonomi organization.
14+
15+
Moving the content into a newly created repository would split or duplicate the repository's identity and risk losing continuity across history, pull requests, issues, references, and integrations. GitHub's repository-transfer mechanism instead moves the existing repository object, preserving its repository ID and Git history while changing its organization namespace.
16+
17+
The transfer also changes the namespace embedded in the Worker's GitHub raw origin and the whitepaper PDF links. The destination `WithAutonomi/autonomi-llm-docs` does not exist before the manual transfer, so those changes cannot safely become live until the repository exists there and its post-transfer controls have been validated.
18+
19+
ADR-0002 and ADR-0005 name the current MaidSafe repository because they record the architecture as it existed when those decisions were accepted. They are immutable historical records. Their broader decisions—Cloudflare Worker delivery backed by GitHub, this repository as the source of truth, and source-controlled Worker operations—remain in force.
20+
21+
## Decision Drivers
22+
23+
- Align repository ownership and operational control with the Autonomi team.
24+
- Preserve one repository object, its ID, full Git history, and associated GitHub history.
25+
- Establish one unambiguous canonical repository and GitHub raw origin.
26+
- Keep the `autonomi.com` documentation service and all five whitepaper PDFs available through a controlled cutover.
27+
- Avoid relying on a permanent redirect, mirror, or dual-origin Worker implementation.
28+
- Preserve the audit trail and broader decisions in Accepted ADR-0002 and ADR-0005.
29+
30+
## Considered Options
31+
32+
1. Leave the repository in `maidsafe` and continue operating it across organization boundaries.
33+
2. Create a new repository under `WithAutonomi` and copy or mirror the content and history.
34+
3. Manually transfer the existing GitHub repository object to `WithAutonomi`, then make the destination namespace canonical.
35+
36+
## Decision
37+
38+
Jim Collinson will manually transfer the existing GitHub repository object from `maidsafe/autonomi-llm-docs` to `WithAutonomi/autonomi-llm-docs`. The transfer must preserve the repository ID and Git history; creating a replacement repository is not an equivalent migration.
39+
40+
Once this ADR is accepted and the manual transfer has completed, `WithAutonomi/autonomi-llm-docs` is the canonical repository. `https://raw.githubusercontent.com/WithAutonomi/autonomi-llm-docs/main` is the canonical GitHub raw origin for the Cloudflare Worker and repository-hosted assets.
41+
42+
ADR-0002 and ADR-0005 remain immutable and continue to govern the broader Cloudflare/GitHub serving architecture and source-control model. Where their literal pre-transfer repository namespace conflicts with this ADR, this ADR is authoritative once Accepted. ADR-0004 remains the decision governing direct GitHub-raw PDF delivery and is aligned to the destination namespace while still Proposed.
43+
44+
GitHub's old-namespace redirect is transitional compatibility for a controlled, short cutover window, not a second canonical origin or a permanent dependency. No temporary dual-origin Worker logic will be introduced. The path `maidsafe/autonomi-llm-docs` must never be recreated, because doing so would capture old links and invalidate the redirect to the transferred repository.
45+
46+
The implementation PR may be prepared before the transfer so it travels with the repository, but it must not be merged or deployed until the destination exists and post-transfer repository controls have been validated. Preview deployment and validation must precede the separately approved production deployment.
47+
48+
## Consequences
49+
50+
### Positive
51+
52+
- Repository ownership, team access, and operational responsibility align under `WithAutonomi`.
53+
- Repository identity, Git history, and GitHub continuity are preserved instead of copied or fragmented.
54+
- The Worker and PDF links converge on one canonical raw-content origin.
55+
- The short redirect window provides compatibility while the prepared implementation is validated and deployed.
56+
57+
### Negative / Trade-offs
58+
59+
- There is a cutover interval in which the old namespace redirects while the live Worker still uses its pre-transfer raw origin.
60+
- Repository settings, access, secrets, environments, branch controls, and integrations require explicit post-transfer validation.
61+
- Absolute raw URLs must change with the organization namespace.
62+
63+
### Neutral / Operational
64+
65+
- The repository transfer itself is a manual, human-owned GitHub operation.
66+
- Merging the implementation and deploying the Worker remain separate actions, with production deployment protected by environment approval.
67+
- Historical MaidSafe content, company references, email addresses, and organization links that are not the repository's current namespace remain unchanged.
68+
69+
## Validation
70+
71+
The transfer remains valid only if the destination reports the same GitHub repository ID and expected `main` commit SHA as the source, and the old and new GitHub raw URLs return byte-identical content during the redirect window. Repository CI must pass in the destination, and organization/repository access, branch controls, secrets, protected deployment environment approval, workflows, webhooks, GitHub Apps, and other required integrations must be confirmed after transfer.
72+
73+
The implementation must then be validated through preview before the separately approved production deployment. After production deployment, canonical `autonomi.com` documentation paths must serve content from the destination raw origin, and all five whitepaper Markdown pages must download their corresponding PDFs from that origin with the expected hashes. Any repository ID or SHA mismatch, raw-content hash mismatch, CI failure, missing approval control, broken canonical document, PDF mismatch, or lost required access/integration blocks completion of the cutover.
74+
75+
Review triggers include another repository owner or name change, a change to the canonical raw-content host, replacement of the GitHub repository object, or any proposal to recreate the old namespace.
76+
77+
## Notes for AI-assisted work
78+
79+
AI tools may help draft this ADR, but **must not mark it Accepted without human review**. Accepted ADRs are immutable: create a new superseding ADR rather than editing an Accepted ADR. AI tools must not perform the repository transfer, merge or deploy the implementation, recreate the old namespace, or introduce dual-origin compatibility without a new approved decision.

whitepapers/autonomous-network.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
**Organisation**: MaidSafe.net, South Ayrshire, Scotland, UK.
55
**First Published:** September 2010.
66

7-
**Download PDF:** [Autonomous Network Paper](https://raw.githubusercontent.com/maidsafe/autonomi-llm-docs/main/whitepapers/Autonomous-Network.pdf)
7+
**Download PDF:** [Autonomous Network Paper](https://raw.githubusercontent.com/WithAutonomi/autonomi-llm-docs/main/whitepapers/Autonomous-Network.pdf)
88

99
---
1010
## Abstract

whitepapers/distributed-file-system.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
**Organisation:** MaidSafe.net, South Ayrshire, Scotland, UK.
55
**First published**: September 2010.
66

7-
**Download PDF:** [Distributed File System Paper](https://raw.githubusercontent.com/maidsafe/autonomi-llm-docs/main/whitepapers/MaidSafe-Distributed-File-System.pdf)
7+
**Download PDF:** [Distributed File System Paper](https://raw.githubusercontent.com/WithAutonomi/autonomi-llm-docs/main/whitepapers/MaidSafe-Distributed-File-System.pdf)
88

99
---
1010

whitepapers/distributed-hash-table.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
**Organisation:** MaidSafe.net, South Ayrshire, Scotland, UK.
55
**First Published:** September 2010
66

7-
**Download PDF:** [Distributed Hash Table Paper](https://raw.githubusercontent.com/maidsafe/autonomi-llm-docs/main/whitepapers/MaidSafe-Distributed-Hash-Table.pdf)
7+
**Download PDF:** [Distributed Hash Table Paper](https://raw.githubusercontent.com/WithAutonomi/autonomi-llm-docs/main/whitepapers/MaidSafe-Distributed-Hash-Table.pdf)
88

99
---
1010

whitepapers/self-authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
**Organisation:** MaidSafe.net, South Ayrshire, Scotland, UK.
55
**First Published:** September 2010
66

7-
**Download PDF:** [Self-Authentication Paper](https://raw.githubusercontent.com/maidsafe/autonomi-llm-docs/main/whitepapers/Self-Authentication.pdf)
7+
**Download PDF:** [Self-Authentication Paper](https://raw.githubusercontent.com/WithAutonomi/autonomi-llm-docs/main/whitepapers/Self-Authentication.pdf)
88

99
---
1010

whitepapers/self-encrypting-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
**Organisation:** MaidSafe.net, South Ayrshire, Scotland, UK.
55
**First Published:** September 2010. Revised June 2015.
66

7-
**Download PDF:** [Self Encrypting Data Paper](https://raw.githubusercontent.com/maidsafe/autonomi-llm-docs/main/whitepapers/Self-Encrypting-Data.pdf)
7+
**Download PDF:** [Self Encrypting Data Paper](https://raw.githubusercontent.com/WithAutonomi/autonomi-llm-docs/main/whitepapers/Self-Encrypting-Data.pdf)
88

99
---
1010
## Abstract

worker/README.markdown

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This directory contains source-controlled Cloudflare Worker code and deployment configuration for the existing production Worker `autonomi-md-proxy`.
44

5-
## Current production inventory
5+
## Production configuration
66

77
- Worker name: `autonomi-md-proxy`
88
- Production route: `autonomi.com/*`
@@ -11,7 +11,7 @@ This directory contains source-controlled Cloudflare Worker code and deployment
1111
- `workers_dev`: disabled for production
1212
- Connected bindings: none
1313
- Observability: logs enabled with 100% sampling; traces disabled in the confirmed production inventory
14-
- Behaviour: serve public `.md`, `/llms.txt`, and `/llms-full.txt` paths from `maidsafe/autonomi-llm-docs` on GitHub, excluding internal prefixes `/worker/` and `/.github/`, and falling back to Framer for misses and all other paths
14+
- Source-controlled behaviour: serve public `.md`, `/llms.txt`, and `/llms-full.txt` paths from `WithAutonomi/autonomi-llm-docs` on GitHub, excluding internal prefixes `/worker/` and `/.github/`, and falling back to Framer for misses and all other paths
1515

1616
## Local setup
1717

@@ -106,6 +106,7 @@ curl -i "$PREVIEW_URL/llms.txt"
106106
curl -i "$PREVIEW_URL/llms-full.txt"
107107
curl -i "$PREVIEW_URL/overview.md"
108108
curl -i "$PREVIEW_URL/worker/README.md"
109+
curl -i "$PREVIEW_URL/missing.md"
109110
curl -i "$PREVIEW_URL/"
110111
```
111112

@@ -118,6 +119,7 @@ curl -i https://autonomi.com/llms.txt
118119
curl -i https://autonomi.com/llms-full.txt
119120
curl -i https://autonomi.com/overview.md
120121
curl -i https://autonomi.com/worker/README.md
122+
curl -i https://autonomi.com/missing.md
121123
curl -i https://autonomi.com/
122124
```
123125

worker/src/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ export default {
9090
(request.method === "GET" || request.method === "HEAD")
9191
) {
9292
// Try to fetch from GitHub
93-
const githubUrl = `https://raw.githubusercontent.com/maidsafe/autonomi-llm-docs/main${url.pathname}`;
93+
const githubUrl = `https://raw.githubusercontent.com/WithAutonomi/autonomi-llm-docs/main${url.pathname}`;
9494

9595
try {
9696
const ghResponse = await fetch(githubUrl, { method: request.method });

0 commit comments

Comments
 (0)