docs/DEV-SETUP.md
Dev Setup
This guide is the shortest path from a fresh checkout to a usable Mycel development environment.
Generated English Docs Index
This page is generated from selected English Markdown sources in the repository. It lists project docs, protocol references, profiles, and design notes with a short opening note taken from each file's heading section.
The short note prefers a leading Status: line when one exists, otherwise it
falls back to the first summary paragraph under the document title.
16 documents
High-level project overviews, roadmap materials, and public-facing reference notes.
docs/DEV-SETUP.md
This guide is the shortest path from a fresh checkout to a usable Mycel development environment.
README.md
Mycel is a Rust-based protocol stack for verifiable text history, governed reading state, and decentralized replication.
docs/MYCEL-CHARACTERISTICS.md
This document explains several characteristic terms commonly used to describe Mycel, what each term means in Mycel, and what it should not be mistaken for.
docs/FEATURE-REVIEW-CHECKLIST.md
This document is a recurring review list for any proposed new Mycel feature.
docs/MYCEL-GRANT-CONCEPT-NOTE.md
Mycel: Verifiable Text History, Governed Reading State, and Decentralized Replication
docs/PROGRESS.md
This page turns ROADMAP.md and IMPLEMENTATION-CHECKLIST.en.md into one quick progress view.
ROADMAP.md
This roadmap turns the current README priorities, implementation checklist, and design-note planning guidance into one repo-level build sequence.
SPEC-ISSUES.md
This document tracks protocol-spec issues that are likely to cause interoperability problems, ambiguous validation behavior, or incompatible implementations.
IMPLEMENTATION-CHECKLIST.en.md
This checklist translates the v0.1 spec into an implementation-oriented build plan for a minimal interoperable client.
docs/MYCEL-WIRE-SESSION-XSTATE-DRAFT.md
This document sketches how we could model a minimal Mycel wire session as an XState machine. The goal is not to replace the current Rust implementation. The goal is to make session states, message ordering, guards, an...
PROJECT-INTENT.md
Illustrative conditions and corresponding possible Mycel uses:
docs/PROJECT-NAMING.md
This document defines how Mycel and MycelLayer should be used across the repository and public-facing surfaces.
RUST-WORKSPACE.md
This note describes the first Rust workspace cut for Mycel.
SECURITY.md
Mycel is currently an early-stage, spec-first project.
docs/MYCEL-GAP.md
This document explains why protocols like Mycel have been relatively rare, and how the problems Mycel is trying to address are usually handled today.
docs/MYCEL-VALUE.md
This document rewrites Mycel's value proposition in a form that is easier to explain outwardly: instead of starting with protocol mechanics, it starts with the pain points people already feel in today's tools.
2 documents
Core protocol and wire-level reference documents.
PROTOCOL.en.md
Mycel is a text protocol with the following characteristics:
WIRE-PROTOCOL.en.md
This document defines the transport-level message format and minimum synchronization flow for Mycel nodes.
2 documents
Profile documents that define governed interpretations and application-specific shapes.
PROFILE.fund-auto-disbursement-v0.1.en.md
This profile defines a narrow interoperable model for automatic fund disbursement built on top of Mycel app-layer records, accepted-state selection, and policy-driven m-of-n custody.
PROFILE.mycel-over-tor-v0.1.en.md
This profile defines a narrow deployment model for running Mycel over Tor-oriented transport.
39 documents
Deeper design explorations for protocol, app-layer, and governance concepts.
docs/design-notes/DESIGN-NOTES.auto-signer-consent-model.en.md
This note describes how a Mycel-based system should model consent for automatic threshold signers.
docs/design-notes/DESIGN-NOTES.canonical-text-profile.en.md
This note describes a neutral text profile for carrying structured, cited, and annotated canonical corpora on top of Mycel.
docs/design-notes/DESIGN-NOTES.client-non-discretionary-multi-view.en.md
This note describes one way to keep Mycel multi-view while minimizing how much ordinary clients can influence the active accepted head.
docs/design-notes/DESIGN-NOTES.commentary-citation-schema.en.md
This note defines a narrow app-level schema for maintainer-authored commentary works that heavily cite one or more source documents without overwriting them.
docs/design-notes/DESIGN-NOTES.donation-app-layer.en.md
This note describes a donation-oriented application layer carried by Mycel while keeping payment execution outside the core protocol.
docs/design-notes/DESIGN-NOTES.dynamic-module-loading.en.md
This note proposes a conservative way for a Mycel-based app to load executable extension logic at runtime and download missing modules on demand.
docs/design-notes/DESIGN-NOTES.enterprise-messenger-app-layer.en.md
This note describes how Mycel can carry an enterprise instant messenger app for internal planning, operations, and compliance-heavy collaboration without turning the core protocol into a chat transport, DLP engine, or...
docs/design-notes/DESIGN-NOTES.first-client-scope-v0.1.en.md
This note defines the narrowest practical first-client scope for Mycel.
docs/design-notes/DESIGN-NOTES.forum-qa-relationship.en.md
This note defines the relationship between the Forum App Layer and the Q&A App Layer.
docs/design-notes/DESIGN-NOTES.forum-app-layer.en.md
This note describes how Mycel could carry a forum-style application layer while keeping forum semantics outside the protocol core.
docs/design-notes/DESIGN-NOTES.future-software-ecosystem-on-mycel-runtime-substrate.en.md
This note imagines a future where Mycel-style signed, on-demand runtime loading is no longer a niche architecture choice, but part of the mainstream software environment.
docs/design-notes/DESIGN-NOTES.governance-history-security.en.md
This note describes how a Mycel-based system should secure governance history so that decisions remain verifiable, replayable, and recoverable over time.
docs/design-notes/DESIGN-NOTES.interpretation-dispute-model.en.md
This note describes how Mycel can model, preserve, and arbitrate interpretation disputes without silently replacing root text or forcing all deployments into one universal reading.
docs/design-notes/DESIGN-NOTES.metadata-merge-boundaries.en.md
This note records the current M2 metadata-merge boundary for the conservative merge-authoring flow.
docs/design-notes/DESIGN-NOTES.minimal-mycel-host-bootstrap.en.md
This note describes the smallest practical local bootstrap that could host Mycel as a signed, on-demand runtime substrate.
docs/design-notes/DESIGN-NOTES.mycel-anonymity-model.en.md
This note describes how a Mycel-based system should reason about anonymity as a multi-layer property rather than a single transport setting.
docs/design-notes/DESIGN-NOTES.mycel-app-layer.en.md
This note describes an application layer carried by Mycel while keeping side-effect execution outside the core protocol.
docs/design-notes/DESIGN-NOTES.app-signing-model.en.md
This note describes how a Mycel-based system should think about application signing as a layered model rather than one single signature decision.
docs/design-notes/DESIGN-NOTES.signed-on-demand-runtime-substrate.en.md
This note explores a more ambitious interpretation of Mycel: not only as a protocol for verifiable text and governance, but as a substrate where most application logic can be fetched, verified, and executed on demand.
docs/design-notes/DESIGN-NOTES.blind-address-threat-model.en.md
This note describes the main threat surfaces, trust boundaries, and control requirements for a Mycel deployment that uses a blind-address custody model.
docs/design-notes/DESIGN-NOTES.mycel-full-stack-map.en.md
This note maps the current Mycel document set into a full-stack system view.
docs/design-notes/DESIGN-NOTES.maintainer-conflict-flow.en.md
This note describes how a Mycel deployment should model and preserve a conflict between maintainers over a document idea or direction without collapsing the conflict into silent overwrite.
docs/design-notes/DESIGN-NOTES.mycel-protocol-upgrade-philosophy.en.md
This note describes how Mycel should evolve its protocol, profiles, and design notes without turning the core specification into a fast-moving target.
docs/design-notes/DESIGN-NOTES.signature-role-matrix.en.md
This note maps the main object families in the current repo to the roles that should sign them.
docs/design-notes/DESIGN-NOTES.signature-priority.en.md
This note organizes which object families in the current Mycel repo should require signatures first, rather than treating every possible object family as equally urgent.
docs/design-notes/DESIGN-NOTES.signer-activity-model.en.md
This note describes how a Mycel-based custody deployment should evaluate signer activity rather than treating signer availability as a binary guess.
docs/design-notes/DESIGN-NOTES.signer-availability-emergency-response.en.md
This note describes how a Mycel-based m-of-n custody deployment should detect dangerous signer-availability decline and trigger emergency rotation, address renewal, or other recovery paths before practical lockout occ...
docs/design-notes/DESIGN-NOTES.peer-discovery-model.en.md
This note describes how a Mycel-based system should discover, classify, and retain peers without assuming one universal global discovery mode.
docs/design-notes/DESIGN-NOTES.peer-simulator-v0.en.md
This note defines a narrow multi-peer simulator for early Mycel implementation testing.
docs/design-notes/DESIGN-NOTES.policy-driven-threshold-custody.en.md
This note describes a custody model where Mycel carries the policy and governance history for fund movements, while an m-of-n signer network executes approved transactions automatically under fixed policy constraints.
docs/design-notes/DESIGN-NOTES.qa-app-layer.en.md
This note describes a Q&A application layer carried by Mycel while keeping domain-specific interpretation and advisory workflows outside the core protocol.
docs/design-notes/DESIGN-NOTES.qa-minimal-schema.en.md
This note defines a minimal app-level schema for a Mycel-carried Q&A application.
docs/design-notes/DESIGN-NOTES.realtime-media-app-layer.en.md
This note describes how Mycel can support realtime audio/video services without turning the core protocol or wire layer into a media-streaming transport.
docs/design-notes/DESIGN-NOTES.relay-node-layering.en.md
This note defines where a relay node belongs in Mycel's layer model.
docs/design-notes/DESIGN-NOTES.sensor-triggered-donation.en.md
This note describes an app/profile architecture where a runtime observes machine-derived user-state events and may create donation-related records under a pre-authorized consent policy.
docs/design-notes/DESIGN-NOTES.text-worker-editor.en.md
This note describes a future editor surface for serious text work on top of Mycel.
docs/design-notes/DESIGN-NOTES.text-worker-editor-implementation.en.md
This note describes a plausible implementation plan for a future Mycel text-worker editor.
docs/design-notes/DESIGN-NOTES.two-maintainer-role.en.md
This note proposes splitting maintainer responsibility into two explicit roles:
docs/design-notes/DESIGN-NOTES.viewer-editor-view-maintainer-checks-and-balances.en.md
This note proposes a checks-and-balances model for Mycel with three distinct roles: