academy/spec
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Protocol specification, governance, legal, and project plan
77 commits 1 branch 0 tags 3.8 MiB
  • Python 100%
Find a file
Exact
Ricardo Satoshi 069ea1661c Release v1.0.0: media archive + search, forum controls, seed boards
2026-07-17 05:24:17 -04:00
.gitea Ready the repos for community contribution and strip the AI fingerprints. airules.md becomes CONTRIBUTING.md, reframed from 'rules for any AI assistant' into a contribution guide (how the mechanical forge-governor merge works, pseudonymous-friendly with no CLA, the spec-is-authoritative rule, and the nine house rules). Add CODE_OF_CONDUCT.md and SECURITY.md (both adapted to a project with no central maintainer and no server to patch: fixes ship as signed threshold releases), plus .gitea issue and pull-request templates. push.sh distributes all four docs and the templates into every code repo from a single source, drops the Co-Authored-By: Claude trailer from commits, and removes the airules orphan. READMEs across spec/node/website/desktop/.profile updated: airules references retargeted, stale 'engine not built yet' status corrected, desktop and the ceremony/nmt crates added to the tables. Neutralized the incidental Claude/AI mentions in .gitignore and plan.txt; the FAQ's 'why not an AI chatbot' product copy stays. 2026-07-14 03:39:17 -04:00
.gitattributes Initial import: protocol spec, plan, contribution rules, and legal documents 2026-07-12 01:01:12 -04:00
.gitignore Initial import: protocol spec, plan, contribution rules, and legal documents 2026-07-12 01:01:12 -04:00
CODE_OF_CONDUCT.md Ready the repos for community contribution and strip the AI fingerprints. airules.md becomes CONTRIBUTING.md, reframed from 'rules for any AI assistant' into a contribution guide (how the mechanical forge-governor merge works, pseudonymous-friendly with no CLA, the spec-is-authoritative rule, and the nine house rules). Add CODE_OF_CONDUCT.md and SECURITY.md (both adapted to a project with no central maintainer and no server to patch: fixes ship as signed threshold releases), plus .gitea issue and pull-request templates. push.sh distributes all four docs and the templates into every code repo from a single source, drops the Co-Authored-By: Claude trailer from commits, and removes the airules orphan. READMEs across spec/node/website/desktop/.profile updated: airules references retargeted, stale 'engine not built yet' status corrected, desktop and the ceremony/nmt crates added to the tables. Neutralized the incidental Claude/AI mentions in .gitignore and plan.txt; the FAQ's 'why not an AI chatbot' product copy stays. 2026-07-14 03:39:17 -04:00
CONTRIBUTING.md Ready the repos for community contribution and strip the AI fingerprints. airules.md becomes CONTRIBUTING.md, reframed from 'rules for any AI assistant' into a contribution guide (how the mechanical forge-governor merge works, pseudonymous-friendly with no CLA, the spec-is-authoritative rule, and the nine house rules). Add CODE_OF_CONDUCT.md and SECURITY.md (both adapted to a project with no central maintainer and no server to patch: fixes ship as signed threshold releases), plus .gitea issue and pull-request templates. push.sh distributes all four docs and the templates into every code repo from a single source, drops the Co-Authored-By: Claude trailer from commits, and removes the airules orphan. READMEs across spec/node/website/desktop/.profile updated: airules references retargeted, stale 'engine not built yet' status corrected, desktop and the ceremony/nmt crates added to the tables. Neutralized the incidental Claude/AI mentions in .gitignore and plan.txt; the FAQ's 'why not an AI chatbot' product copy stays. 2026-07-14 03:39:17 -04:00
DISCLAIMER.md Initial import: protocol spec, plan, contribution rules, and legal documents 2026-07-12 01:01:12 -04:00
forge-governor.py Release v1.0.0: media archive + search, forum controls, seed boards 2026-07-17 05:24:17 -04:00
LICENSE Initial import: protocol spec, plan, contribution rules, and legal documents 2026-07-12 01:01:12 -04:00
plan.txt Release v1.0.0: media archive + search, forum controls, seed boards 2026-07-17 05:24:17 -04:00
PRIVACY.md Initial import: protocol spec, plan, contribution rules, and legal documents 2026-07-12 01:01:12 -04:00
README.md Ready the repos for community contribution and strip the AI fingerprints. airules.md becomes CONTRIBUTING.md, reframed from 'rules for any AI assistant' into a contribution guide (how the mechanical forge-governor merge works, pseudonymous-friendly with no CLA, the spec-is-authoritative rule, and the nine house rules). Add CODE_OF_CONDUCT.md and SECURITY.md (both adapted to a project with no central maintainer and no server to patch: fixes ship as signed threshold releases), plus .gitea issue and pull-request templates. push.sh distributes all four docs and the templates into every code repo from a single source, drops the Co-Authored-By: Claude trailer from commits, and removes the airules orphan. READMEs across spec/node/website/desktop/.profile updated: airules references retargeted, stale 'engine not built yet' status corrected, desktop and the ceremony/nmt crates added to the tables. Neutralized the incidental Claude/AI mentions in .gitignore and plan.txt; the FAQ's 'why not an AI chatbot' product copy stays. 2026-07-14 03:39:17 -04:00
SECURITY.md Ready the repos for community contribution and strip the AI fingerprints. airules.md becomes CONTRIBUTING.md, reframed from 'rules for any AI assistant' into a contribution guide (how the mechanical forge-governor merge works, pseudonymous-friendly with no CLA, the spec-is-authoritative rule, and the nine house rules). Add CODE_OF_CONDUCT.md and SECURITY.md (both adapted to a project with no central maintainer and no server to patch: fixes ship as signed threshold releases), plus .gitea issue and pull-request templates. push.sh distributes all four docs and the templates into every code repo from a single source, drops the Co-Authored-By: Claude trailer from commits, and removes the airules orphan. READMEs across spec/node/website/desktop/.profile updated: airules references retargeted, stale 'engine not built yet' status corrected, desktop and the ceremony/nmt crates added to the tables. Neutralized the incidental Claude/AI mentions in .gitignore and plan.txt; the FAQ's 'why not an AI chatbot' product copy stays. 2026-07-14 03:39:17 -04:00
SPEC.md Release v1.0.0: media archive + search, forum controls, seed boards 2026-07-17 05:24:17 -04:00
TERMS.md Initial import: protocol spec, plan, contribution rules, and legal documents 2026-07-12 01:01:12 -04:00
WHITEPAPER.md Release v1.0.0: media archive + search, forum controls, seed boards 2026-07-17 05:24:17 -04:00

README.md

Academy Network

Free, universal, uncensorable education. A decentralized network of hierarchical how-to guides that lives on the machines of the people who read it, with no servers and no owner.

Academy Network is a desktop application: every user who runs it is a node, peers connect over Tor, and all guide text is replicated to every node so reading is instant and works offline. There is no central server to shut down, censor, or surveil. The only hosted thing is a static download site.

Status: engine complete, desktop client in progress. The protocol is fully specified, and the Rust engine (core, networking, editorial runtime, headless seed, and the ceremony tool) is built and tested, with a seed node already live on Tor. What remains is the desktop client and the network's genesis ceremony. See plan.txt for the roadmap and build order.

Start here

  • SPEC.md: the authoritative protocol specification. The network is defined by this document; the code is one implementation of it. Anyone must be able to build a compatible client from the spec alone.
  • plan.txt: the full plan, architecture, and decision log.
  • CONTRIBUTING.md: how to contribute, the house rules, and how the community merges changes. It ships in every repository, alongside a code of conduct (CODE_OF_CONDUCT.md) and a security policy (SECURITY.md).
  • design/STYLE.md (in the website repository): the locked visual design system.

Repositories

The project is split into one repository per concern, all under git.academynetwork.net/academy:

Repository What
spec This repo: protocol specification (authoritative), plan, contribution docs, legal
node The Rust workspace: core, net, editorial, seed, ceremony, all built and tested
desktop The Tauri desktop client: the app a person installs to become a node
website SvelteKit static site plus the canonical design system (stylesheet, shell, logos)

This repo's own layout:

Path What
SPEC.md Protocol specification (authoritative)
plan.txt Roadmap, architecture, decision log
CONTRIBUTING.md How to contribute and the house rules
CODE_OF_CONDUCT.md Community norms
SECURITY.md How to report vulnerabilities
LICENSE, TERMS.md, PRIVACY.md, DISCLAIMER.md Legal

Build

See each repository's README: the node repo builds with plain cargo test / cargo build, and the website repo is a fully prerendered SvelteKit static site (no server routes, analytics, or third-party requests).

Contributing

The submission and review model is described on the website's Contributing page and in SPEC.md. Two hard rules to know up front:

  • The protocol is defined by SPEC.md. If code and spec disagree, the code is the bug: update the spec first, then the code.
  • Follow CONTRIBUTING.md. In particular: never use em dashes anywhere, the visual style is locked, and the website stays fully static. Be a good neighbour (CODE_OF_CONDUCT.md) and report vulnerabilities per SECURITY.md.

License

  • Code (the client and the core crate): GNU Affero General Public License, version 3 or later. See LICENSE.
  • Specification and documentation: Creative Commons Attribution-ShareAlike 4.0 (CC BY-SA 4.0), so the network stays reimplementable by anyone, forever.

By publishing content to the network you license it under CC BY-SA 4.0. See TERMS.md.