Docsloth / developers
Self-hostStart quickstart

docsloth.dev

Developer documentation

Everything below is implemented and tested in this release: 48 components, the core API contract, the CLI and the MCP server.

Start here

Quickstart

Five commands from clone to a private preview, with no account.

API reference

Conventions and the full operation list from the published contract.

CLI and packages

The @docsloth/cli commands and every published package with its licence.

MCP for agents

Read-only tools, honest errors and environment-based credentials.

Agent guides

AGENTS.md/SKILL.md generation with consent, plus machine-readable publications.

Reference

How generated reference pages are structured and versioned.

Operations, registry and credentials

Self-host

Compose profile or CLI mode, no account and no telemetry by default; the free paths live on docsloth.org.

BYOK models

Deployment BYOK and hosted per-tenant credentials, with the exact write/probe/delete paths.

Examples

Runnable request sequences with the version and environment that were tested.

The manuals for these topics are maintained in the repositories listed below, so the text and the code move together. This site keeps the task-ordered entry points.

Component catalogue (48)

ComponentTrust classPurpose
prosepureReadable structured narrative
calloutpureImportant contextual warnings
tabsinteractiveSwitch related presentations
tableinteractiveFilterable structured reference
codeinteractiveSyntax-highlighted copyable code
code-diffinteractiveInspect a versioned example change
live-codeconnectedExecute an example in an approved environment
terminalconnectedInteractive command example with sandbox binding
api-consoleconnectedBuild and send approved API requests
api-referencepureRender canonical API schema and examples
schema-explorerinteractiveExplore an object or database schema
graphinteractiveExplore services and software relationships
sequenceinteractiveExplain message ordering
state-machineinteractiveExplore a bounded state machine
tutorialconnectedVerified multistep task tutorial
wizardconnectedCollect configuration and validate prerequisites
chatagenticPage-scoped sourced documentation assistance
chat-bubbleagenticFloating contextual documentation assistant
troubleshooteragenticDiagnose an authorized redacted error
agent-taskagenticRun a scoped documentation task
searchinteractivePublished content search with static fallback
videointeractiveAccessible recorded walkthrough
gifpureShort annotated motion with static alternative
imagepureAccessible versioned screenshot
release-timelineinteractivePublished version and migration history
migrationinteractiveBefore-and-after change guide
permissionsinteractiveRead-only permission matrix
configuratorconnectedPrepare safe software configuration
webhook-debuggerconnectedInspect synthetic approved webhook delivery
event-streamconnectedInspect an authorized event stream
logsconnectedView redacted approved diagnostic logs
statusconnectedRead-only authorized deployment status
feedbackconnectedSubmit bounded document feedback
checklistinteractiveTrack local tutorial progress
cardspureChoose task-oriented navigation
breadcrumbspureShow page hierarchy
version-selectorinteractiveChoose an actual available release
locale-selectorinteractiveChoose an available language
copy-contextconnectedExport permitted agent context
apply-to-repoagenticPrepare a reader-authorized integration PR
embedconnectedIsolated approved external UI
metricsconnectedDisplay authorized aggregate metrics
media-transcriptpureAccessible transcript tied to media version
faqpureTask-oriented evidenced question answers
glossaryinteractiveSoftware terminology and concepts
downloadconnectedIntegrity-checked approved artifact download
pricing-referencepureOwner-sourced product prices; never inferred from code
source-evidenceinteractiveExpose audience-safe verification evidence
Read the quickstartCompare approaches

Repository manuals

Repository visibility is controlled by the project owner; where a repository is not public yet, the licence map and the published contracts remain the reference. Agents can read /llms.txt for a machine index of this host.