Developer guide index

Operator guides for platform deployments are maintained separately in the Woodfine fleet deployment catalog. Those are operational documents for system operators and are not listed here.

The Developer Guide Index lists the task-oriented how-to guides for the PointSav platform, organised by developer concern. Each guide covers a specific task a developer performs when building with or deploying the platform. For the underlying architecture that each guide draws on, follow the article wikilinks within each guide.

Internal operator runbooks for the Woodfine fleet deployment are not listed here — they are operational documents for provisioning and maintenance, not public developer guides.

Getting started

These guides cover the first steps for a developer new to the platform — setting up the toolchain, authenticating a device, and opening a working session.

• Pair a new device — register a new device with the pairing server and get it approved onto the network
• How to install the development toolchain — install the Rust compiler and the workspace commit helper on a workspace VM
• Open your first Totebox session — open a scoped working session in a Totebox Archive and navigate the session lifecycle
• Explore the console for the first time — tour the three-zone TUI, read the status bar, and navigate F-key slots for the first time

Working in the console

These guides cover the platform's terminal interface and its F-key Cartridge slots.

• Navigate the console TUI — the real screen layout and status bar fields, and switching slots without losing state
• Use the F-key cartridge model — what F3, F9, and F12 actually do, correcting two invented behaviors
• Read the command ledger — page ledger entries and fetch a signed checkpoint over service-fs's real HTTP API
• Run your first SLM query — the real path to a first inference request, since F9 has no query interface at all

Records & storage

These guides cover the WORM audit ledger and entity data operations.

• How to read and write Totebox archives — the five-step session start reading protocol, commit flow, draft staging, cross-archive mailbox
• Verify a WORM ledger entry — confirm hash-chain integrity using SHA-256 and validate against a signed Sigstore checkpoint
• Query the DataGraph — search named entities by plain-text query, navigate relationships, handle Tier A circuit outages
• Export structured data from the platform — four export paths by use case: DataGraph, wiki Markdown, GeoJSON, ledger tiles

Machine authorization

These guides cover the credential and admission mechanisms that gate who and what can act on the platform — device pairing, service-to-service capability tokens, fleet node enrollment, and signed binary downloads. These are separate mechanisms, not one system under different names.

• Pair a new device — register a device with the pairing server and get it approved onto the WireGuard mesh
• Issue a capability token — mint an Ed25519-signed capability token and register it with a peer service
• Rotate keys and capability tokens — replace a credential within the system's real 24-hour expiry limits; there is no revocation mechanism
• Enroll a PPN node — start the per-node heartbeat agent and confirm it in the fleet controller
• Authenticate binary downloads — confirm an order and follow the signed download path for a release

For the authorization model that underpins all these operations, see Machine-based authorization and Pairing as permission.

Multi-entity scale

These guides cover operating the platform across multiple tenants, users, and fleet nodes.

• Configure a tenant namespace — register a tenant namespace, set quota limits, verify isolation, and issue the root credential
• Scale user access — promote users between READ / USER / INPUT tiers; bulk-update a team at scale
• Add a node to a running fleet — enroll a second PPN node into a running fleet without interrupting existing nodes

Integration & data

These guides cover consuming platform data and connecting external applications.

• Build a co-location map — authenticate against the GIS tile API and render tier-coloured cluster markers in MapLibre
• Connect to the OSM data pipeline — write a chain ingest YAML, run the ingest script against the Overpass API, and rebuild the cluster layer
• Federate archives via content mounts — declare a secondary content mount in knowledge.toml and access federated articles across instances
• Use declarative knowledge mounts — add a secondary content repository to a running wiki instance and verify slug isolation

Self-hosting

These guides cover deploying and running platform components on operator-controlled infrastructure.

• Self-host a deployment — provision a named deployment instance, start the gateway, and connect it to the upstream platform
• Configure the Doorman gateway — configure Tier A/B/C upstream addresses, circuit-breaker thresholds, and verify the health endpoint
• Deploy a knowledge instance — build and start app-mediakit-knowledge pointed at a local content repository path
• Run local SLM inference — start the local SLM service, verify Doorman Tier B, and submit inference requests from the console or API

See also

• Machine-based authorization — the machine-based authorization model underlying all platform access
• Totebox orchestration as the development environment — the session orchestration model that governs how Totebox Archives are used
• MediaKit knowledge application — the wiki engine serving this documentation instance