MiCyteThe explanations, collected
The wiki.
34 documents, written while the software was built and kept with it: the repository’s own wiki, rendered here so it can be read without a checkout. Every page links the file it came from.
Development statuswhat is built, what is written down
Built
28The code looks like this today.
- MiCyte — overview and glossaryas-built (index)
- 05 — Engineering standardsas-built
- 10 — L1 core engineas-built
- 20 — L2 persistenceas-built
- 30 — L3 shell, runtime and UIas-built
- 40 — Tools, channels, routines and lensesas-built
- 41 — Archetypes and viewscopesas-built
- 42 — The glyph libraryas-built
- 43 — The local domainas-built
- 44 — Project documentsas-built
- 46 — The applicationsas-built (index)
- Almanacas-built
- Brevatas-built
- Claudeas-built
- Directoras-built
- Enchiras-built
- FND Serviceas-built
- Oveureas-built
- PIMas-built
- Quiar – Freelanceras-built
- 61 — MSS forms and the hyphae payloadas-built
- 90 — Network and contractsas-built; the parts that are not built are listed at the end
- 91 — Channelsas-built. The four channel types are declared and enforced; no channel records posts of…
- 92 — Ports: type, extension, binding, grantas-built
- 93 — The marketplaceas-built
- 98 — Taking your data with youhow-to. The archive, its download and its checks are as-built.
- 99 — What is not builtas-built (a list of gaps)
- Separation and responsibilityas-built
Designed
2Written down and agreed; not built, or built in part.
- 60 — Canonical datum identity and hyphae flagsdesign-spec, with the parts that are built marked as built
- 96 — Accounts, hosting and accessdesign-spec, with what is built marked as built
Guide
3How to do a thing with what exists.
The apps
10Every app in the catalogue, at the version it is published at, cut against engine 0.6.0. An app carries a version, not a stage — what stage the thing it does is at is the stage of the page that explains it.
- Almanacalmanac 1.1.0
- Brevatbrevat 1.3.0
- Claudeclaude 1.0.0
- Directordirector 1.0.1
- Enchirenchir 1.2.0
- FND Servicefnd_service 1.8.0
- Oveureoveure 1.3.0
- PIMpim 0.5.1
- Published cataloguepublished_catalogue 1.0.0
- Quiar – Freelancerquiar 2.6.1
No document matches.
Orientation
2What the words mean, and the standards the code is held to.
The three layers
3The engine, what persists, and what the screen does.
- 10L1 core engineBuiltmicyte/core/ defines what a datum is, how addresses form SAMRAS trees, how a document reduces to one version hash, and…
- 20L2 persistenceBuiltThe datum store port, its SQLite adapter, and how a document is read from and written to the MOS database.
- 30L3 shell, runtime and UIBuiltThe portal page is described by the shell state machine in micyte/state_machine/, composed per request by the host…
What you build with
15Tools, archetypes, viewscopes, glyphs, the local domain.
- 40Tools, channels, routines and lensesBuiltMiCyte has three registers of things that act on an instance (tools, channels and automation routines) and one registry…
- 41Archetypes and viewscopesBuiltAn archetype is a document that defines a kind of document; a viewscope is the part of an archetype that says how…
- 42The glyph libraryBuiltA glyph is a datum document whose rows decode to one SVG path d attribute; it is how icons are stored in the MOS store.
- 43The local domainBuiltEvery sandbox has a local domain (lcl_domain): its own node id space, stored as one document that both defines each…
- 44Project documentsBuiltA project is a datum document on the instance's tree, built from four row archetypes; a website reads it through its…
- 46The applicationsBuiltThe published catalogue holds ten packages: seven applications, which expose tools, and three extensions, which fill…
- 46AlmanacBuiltAlmanac creates farm fields and plots as nodes of a sandbox's local domain, plans plantings on them, and searches the…
- 46BrevatBuiltBrevat keeps an instance's products, stock, supply purchases, sales and standing offers as datum documents.
- 46ClaudeBuiltClaude is an extension that fills the ai_provider port with Anthropic's Messages API, so the instance can send text to…
- 46DirectorBuiltDirector is the hosting instance's application for managing the instances it has established and the registrar's…
- 46EnchirBuiltEnchir manages the projects an instance keeps and how its connected website presents them.
- 46FND ServiceBuiltFND Service is an extension that fills the email_provider and site_hosting ports with the mail and website services FND…
- 46OveureBuiltOveure edits a sandbox's local domain and the writing attached to its nodes, reads and triages the instance's mail, and…
- 46PIMBuiltPIM is a hosted client's own application for its account, its website and its mail, run on the client's instance…
- 46Quiar – FreelancerBuiltQuiar – Freelancer books jobs, keeps the clients they are for, tracks door-to-door canvassing, and shows the schedule…
The datum, and how it is made
2The canonical form, the spec, the pipeline.
- 60Canonical datum identity and hyphae flagsDesignedA datum's hyphae value is a content-derived token for that datum; a hyphae flag binds a tool or a lens to a hyphae…
- 61MSS forms and the hyphae payloadBuiltMSS (Mycelium Schema Standardisation) encodes a set of datums as one self-delimiting binary sequence in which addresses…
Authoring
3How to write a tool, a lens, or a sandbox to try them in.
- 80Writing a workbench toolGuideThis page lists the steps for adding a workbench tool to micyte/tools/ and the rules the tests enforce on it.
- 81Writing a lensGuideThis page lists the steps for adding a lens and states how the workbench chooses one.
- 82Building a sandbox to develop againstGuideThis page states how to create a sandbox of datum documents for developing and testing tools and lenses, and the rules…
The network
4Contracts, channels, ports, and the marketplace.
- 90Network and contractsBuiltThis page states how one instance publishes its identity, how two instances form an encrypted contract, and how a…
- 91ChannelsBuiltA channel is a read-only session surface that people or instances outside the instance use. It is backed by a sandbox…
- 92Ports: type, extension, binding, grantBuiltA port is a seam through which an instance uses an outside service (email, SMS, an AI provider, site hosting, payments…
- 93The marketplaceBuiltThis page states what a package is, what installing one does, how the catalogue is published to micyte.com, and what an…
Ahead
3The desktop database, accounts and hosting, the roadmap.
- 96Accounts, hosting and accessDesignedThis page states what an account is for, the ways an instance is hosted, what a host must provide, and which parts are…
- 98Taking your data with youBuiltThis page states how to take a complete copy of an instance's records and files, how to check the copy, how to load it…
- 99What is not builtBuiltThis page lists what MiCyte does not do yet, grouped by area. Each item links to the page that states the built part.…
Alongside
2Documents that sit beside the numbered bands.
The source is docs/wiki in the public repository. A new explanation is a file there; it files itself into a band by its number.