Package manifest

Skills

[[skill]]
description = "Find the page, the rule or the prompt in the VibeVM manual that answers the user's question or performs the user's task, locally from the machine store or from vibevm.org/doc"
name = "vibevm-docs"
path = "vibevm/vibespecs/skills/vibevm-docs"

Other languages

04Adaptations of this documentation. A ★ here means «named by the author of this documentation», never «approved by the subject».

The manifest

# The core documentation of VibeVM as a package of kind `doc`
# (spec://org.vibevm.core/vibevm/common/PROP-057#kinds). Like the other
# in-tree packages it is a mutable development slot of one version: the
# content moves, the number stays, and the machine store refreshes by hash.
[package]
name = "vibevm-docs"
group = "org.vibevm.core"
kind = "doc"
version = "1.0.0"
epoch = 1
format = "normal"
authors = ["Oleg Chirukhin"]
license = "UPL-1.0"
description = "The VibeVM manual: install vibe, understand packages and the boot lane, work with an agent, author and publish packages."
keywords = ["documentation", "manual", "vibevm", "packages", "agents", "lifecycle"]
title = "VibeVM Manual"
# Who wrote the prose of these pages, for the reader who wants to know
# (spec://org.vibevm.core/vibevm/common/PROP-057#CARD-AUTHORSHIP). A
# statement about the text and never about the commits: the repository's
# authorship law is PROP-000 `##commits`, and it is unchanged by this.
authorship = "ai"
abstract = """
What it covers: what VibeVM is and how it gives a coding agent the right text to read; installing vibe; creating a project; packages, registries, the lock file and the machine store; installing, updating, publishing and working offline; giving an agent the vibevm skill and asking it to do the work; the lifecycle from validate to deploy; a full command, manifest, lock-file and settings reference; writing packages of every kind, including documentation and its translations.
For whom: people who run vibe in their projects, people who write packages, and the agents that read on their behalf.
What it assumes known: how to use a terminal and a text editor, what a coding agent is, and what a package manager does for a programming language.
What it leaves out: the normative specifications themselves (this manual quotes them, never restates them), the internals of any one agent product, and the design history of vibe.
"""

[compatibility]
min_vibe_version = "1.0.0"
requires_kinds = []

[i18n]
canonical = "en"

# The subject of this documentation: the host itself, a project coordinate
# (spec://org.vibevm.core/vibevm/common/PROP-057#relation).
[[documents]]
package = "org.vibevm.core/vibevm"
version = "^1.0"

# Where the pages stand in the navigation
# (spec://org.vibevm.core/vibevm/common/PROP-057#NAV-PINNED). The two pinned
# pages are the ones a newcomer opens first; every other page keeps the order
# the layer law gives it. The sections are the folders of the page tree, under
# the names this manual already calls them by.
[navigation]
pinned = ["start/what-vibevm-is", "start/index"]

[[navigation.section]]
id = "start"
title = "Start"

[[navigation.section]]
id = "model"
title = "Model"

[[navigation.section]]
id = "howto"
title = "How to"

[[navigation.section]]
id = "agent"
title = "Agent"

[[navigation.section]]
id = "tutorials"
title = "Tutorials"

[[navigation.section]]
id = "lifecycle"
title = "Lifecycle"

[[navigation.section]]
id = "authoring"
title = "Authoring"

[[navigation.section]]
id = "reference"
title = "Reference"

[[navigation.section]]
id = "architecture"
title = "Architecture"

[[navigation.section]]
id = "diagnostics"
title = "Diagnostics"

[[navigation.section]]
id = "faq"
title = "Questions"

[[navigation.section]]
id = "legal"
title = "Legal"

[[navigation.section]]
id = "glossary"
title = "Glossary"

# The learning path: the order a newcomer reads the manual in, chapter by
# chapter, with the reference pages last (PROP-057 ##NAV-CHAPTERS). It moves
# no other order: `pages` in the page manifest and the llms files keep the
# layer law. Every page stands in exactly one chapter; `vibe check` holds that.
[[navigation.chapter]]
id = "getting-started"
title = "Getting started"
pages = ["start/what-vibevm-is", "start/index", "start/install-vibe", "start/first-project", "start/what-a-project-contains"]

[[navigation.chapter]]
id = "advanced-tutorial"
title = "Advanced tutorials"
pages = ["tutorials/ai-native-rust", "tutorials/obsidian-to-project", "tutorials/markdown-and-xml"]

[[navigation.chapter]]
id = "how-a-project-works"
title = "How a project works"
pages = ["model/two-trees", "model/boot-lane", "model/packages-and-kinds", "model/registries"]

[[navigation.chapter]]
id = "everyday-work"
title = "Everyday work with packages"
pages = ["howto/install-a-package", "model/lock-and-store", "model/versions", "howto/update-packages", "howto/remove-a-package", "howto/work-offline", "howto/use-a-private-registry"]

[[navigation.chapter]]
id = "through-your-agent"
title = "Working through your agent"
pages = ["agent/give-your-agent-the-skill", "agent/ask-your-agent", "howto/read-documentation-locally", "agent/how-agents-read-this-manual"]

[[navigation.chapter]]
id = "build-and-ship"
title = "Build and ship a project"
pages = ["lifecycle/phases", "lifecycle/build-package-deploy", "lifecycle/extensions-and-providers", "lifecycle/scrape"]

[[navigation.chapter]]
id = "writing-packages"
title = "Writing packages"
pages = ["authoring/write-a-flow", "authoring/specs-agents-can-cite", "authoring/facts-and-status-markers", "authoring/write-a-feat-or-stack", "authoring/write-a-lang-package", "authoring/ship-tools-and-mcp-servers"]

[[navigation.chapter]]
id = "beyond-one-package"
title = "Beyond one package"
pages = ["model/dependency-visibility", "authoring/bridge-a-repository", "howto/set-up-a-workspace", "howto/publish-to-the-central-registry", "howto/publish-a-package"]

[[navigation.chapter]]
id = "documentation"
title = "Documentation as a package"
pages = ["authoring/write-documentation", "authoring/translate-documentation", "architecture/how-this-manual-is-maintained"]

[[navigation.chapter]]
id = "under-the-hood"
title = "Under the hood"
pages = ["architecture/how-vibe-is-built", "architecture/traceability", "architecture/what-the-lifecycle-epic-delivered"]

[[navigation.chapter]]
id = "appendices"
title = "Appendices"
appendix = true
pages = ["reference/commands", "reference/manifest", "reference/lock-file", "reference/tree", "reference/settings-and-environment", "reference/machine-formats", "diagnostics/errors", "faq/index", "legal/applicable-law", "glossary/index"]

[[skill]]
name = "vibevm-docs"
path = "vibevm/vibespecs/skills/vibevm-docs"
description = "Find the page, the rule or the prompt in the VibeVM manual that answers the user's question or performs the user's task, locally from the machine store or from vibevm.org/doc"

# The page that defines this manual's words, which the style checks read
# to know a term and the reader uses to show its definition beside a
# link (spec://org.vibevm.core/vibevm/common/PROP-057#GLOSSARY-DECLARED).
[glossary]
page = "glossary/index"