Directories
¶
| Path | Synopsis |
|---|---|
|
Package clock is AutoDoc's time: the one Clock a daemon builds and hands to every core package that records a time or compares with one, and a context-aware Sleep.
|
Package clock is AutoDoc's time: the one Clock a daemon builds and hands to every core package that records a time or compares with one, and a context-aware Sleep. |
|
Package config reads AutoDoc's configuration file and resolves the places AutoDoc keeps things: the unix socket the daemon listens on, the state directory, and the store.
|
Package config reads AutoDoc's configuration file and resolves the places AutoDoc keeps things: the unix socket the daemon listens on, the state directory, and the store. |
|
Package derived makes a derived document's text through the build's deriver, for the indexer and the document API alike.
|
Package derived makes a derived document's text through the build's deriver, for the indexer and the document API alike. |
|
Package docs reads and writes a workspace's files for AutoDoc's own apps.
|
Package docs reads and writes a workspace's files for AutoDoc's own apps. |
|
Package edition is what this build of AutoDoc offers beyond its core: the one place a Community build and a Pro build differ.
|
Package edition is what this build of AutoDoc offers beyond its core: the one place a Community build and a Pro build differ. |
|
Package export renders a Markdown document as a standalone HTML page or as plain text, and draws a single Mermaid diagram as a page of its own, for an export and for a preview.
|
Package export renders a Markdown document as a standalone HTML page or as plain text, and draws a single Mermaid diagram as a page of its own, for an export and for a preview. |
|
mermaid
Package mermaid is mermaid.js, vendored: the diagrams a page draws from its ```mermaid blocks, drawn as the Mermaid project draws them.
|
Package mermaid is mermaid.js, vendored: the diagrams a page draws from its ```mermaid blocks, drawn as the Mermaid project draws them. |
|
Package follow keeps a workspace's index following its root.
|
Package follow keeps a workspace's index following its root. |
|
Package hostprobe reads what this machine offers an embedding model, without a network or a provider (ADR 1793005098 §4.2): its GPU (vendor, VRAM, compute capability), its RAM, the free space under the data directory, and whether Ollama answers.
|
Package hostprobe reads what this machine offers an embedding model, without a network or a provider (ADR 1793005098 §4.2): its GPU (vendor, VRAM, compute capability), its RAM, the free space under the data directory, and whether Ollama answers. |
|
Package index is a workspace's derived index in the store (core/store): documents, their chunks under per-document generations, full-text and semantic search over the chunks, tags, aliases, facets, links, and a change log.
|
Package index is a workspace's derived index in the store (core/store): documents, their chunks under per-document generations, full-text and semantic search over the chunks, tags, aliases, facets, links, and a change log. |
|
writertest
Package writertest is the conformance suite of core/index's writer port: what every place the indexer's documents are kept must do, run on the store's own writer and on a destination's (core/pgstore/pgwriter).
|
Package writertest is the conformance suite of core/index's writer port: what every place the indexer's documents are kept must do, run on the store's own writer and on a destination's (core/pgstore/pgwriter). |
|
Package kbtype reads a KB type and plans the files it creates (ADR 1792349867).
|
Package kbtype reads a KB type and plans the files it creates (ADR 1792349867). |
|
Package kind is how AutoDoc reads a file, decided by its extension and never by sniffing its content: Markdown, plain text, YAML, a registered chunker's, or a derived document format, read only as the text a build's deriver makes of it.
|
Package kind is how AutoDoc reads a file, decided by its extension and never by sniffing its content: Markdown, plain text, YAML, a registered chunker's, or a derived document format, read only as the text a build's deriver makes of it. |
|
Package lab is what a lab file is (ADR 1792457255): a Markdown note named *.lab.md whose fenced code cells run in a Jupyter kernel, and whose outputs are files in its companion folder.
|
Package lab is what a lab file is (ADR 1792457255): a Markdown note named *.lab.md whose fenced code cells run in a Jupyter kernel, and whose outputs are files in its companion folder. |
|
Package manifests reads the two manifests AutoDoc installs from a git repo: a plugin's plugin.toml and a Lua package's package.toml.
|
Package manifests reads the two manifests AutoDoc installs from a git repo: a plugin's plugin.toml and a Lua package's package.toml. |
|
Package module is how an AutoDoc feature offers verbs: a Module declares each verb's contract and handler, and the public errors its verbs may answer.
|
Package module is how an AutoDoc feature offers verbs: a Module declares each verb's contract and handler, and the public errors its verbs may answer. |
|
Package outline is a document's structure for navigation: a Markdown file's headings, and the breadcrumb at a place in any document.
|
Package outline is a document's structure for navigation: a Markdown file's headings, and the breadcrumb at a place in any document. |
|
Package paths is the path helpers AutoDoc's core packages share, so each is written once.
|
Package paths is the path helpers AutoDoc's core packages share, so each is written once. |
|
Package pgstore is a tenant-scoped PostgreSQL + pgvector index behind golib's search port: a search.Store[int64, *View] whose views are Semantic, Signaler and Lister, built on golib's dao alone (no SQL of its own beyond its migrations).
|
Package pgstore is a tenant-scoped PostgreSQL + pgvector index behind golib's search port: a search.Store[int64, *View] whose views are Semantic, Signaler and Lister, built on golib's dao alone (no SQL of its own beyond its migrations). |
|
pgtest
Package pgtest gives a test a scratch PostgreSQL database with pgvector: one of its own, made on the server AUTODOC_TEST_PGURL names (a user that may create databases) and dropped when the test ends.
|
Package pgtest gives a test a scratch PostgreSQL database with pgvector: one of its own, made on the server AUTODOC_TEST_PGURL names (a user that may create databases) and dropped when the test ends. |
|
pgwriter
Package pgwriter is core/index's writer port over core/pgstore: a PostgreSQL destination keeping the documents the indexer hands on.
|
Package pgwriter is core/index's writer port over core/pgstore: a PostgreSQL destination keeping the documents the indexer hands on. |
|
Package procstat reads what one process uses of its machine: the daemon's for sys.stats, the app's for autodoc.app.stats (ADR 1792256101 §4.1).
|
Package procstat reads what one process uses of its machine: the daemon's for sys.stats, the app's for autodoc.app.stats (ADR 1792256101 §4.1). |
|
Package registrations is a build's chunkers and derivers, validated once and frozen when it starts: what a main hands app.Main, as the daemon, its indexers and its clients read it.
|
Package registrations is a build's chunkers and derivers, validated once and frozen when it starts: what a main hands app.Main, as the daemon, its indexers and its clients read it. |
|
Package registry is the AutoDoc registry's index format and its rules (ADR 1792351195): the one owner of both.
|
Package registry is the AutoDoc registry's index format and its rules (ADR 1792351195): the one owner of both. |
|
Package schema is a workspace's frontmatter schema: the fields its Markdown files declare in frontmatter, their types, and which are required.
|
Package schema is a workspace's frontmatter schema: the fields its Markdown files declare in frontmatter, their types, and which are required. |
|
Package store is AutoDoc's one store: every workspace, and every workspace's index, in one SQLite file.
|
Package store is AutoDoc's one store: every workspace, and every workspace's index, in one SQLite file. |
|
Package todo is AutoDoc's todo system (ADR 1791532020): the task stores, their format, the rules and every write.
|
Package todo is AutoDoc's todo system (ADR 1791532020): the task stores, their format, the rules and every write. |
|
todotest
Package todotest has in-memory stand-ins for core/todo's ports: a Journal, a disk of directories over golib's memfs, and a workspace table.
|
Package todotest has in-memory stand-ins for core/todo's ports: a Journal, a disk of directories over golib's memfs, and a workspace table. |
|
Package workspace opens a workspace's root: its files as a vfs.FS and the Matcher of its include and exclude patterns.
|
Package workspace opens a workspace's root: its files as a vfs.FS and the Matcher of its include and exclude patterns. |
Click to show internal directories.
Click to hide internal directories.