Vibe.Docs (vibe v0.2.0)

Copy Markdown View Source

Built-in task-focused documentation for Vibe users.

These docs are short operational guides intended for vibe help, TUI help, and eval rendering. API contracts stay in module docs; the README stays focused on first-run orientation.

Summary

Functions

index()

Returns Markdown listing all built-in help topics.

read(topic \\ "quickstart")

Returns Markdown for a built-in help topic.

render(topic)

Returns Markdown for a topic, or the index when the topic is missing or unknown.

topics()

Returns the built-in help topic names and titles.

Functions

index()

@spec index() :: String.t()

Returns Markdown listing all built-in help topics.

read(topic \\ "quickstart")

@spec read(String.t() | atom() | nil) ::
  {:ok, String.t()} | {:error, {:unknown_topic, String.t()}}

Returns Markdown for a built-in help topic.

render(topic)

@spec render(String.t() | atom() | nil) :: String.t()

Returns Markdown for a topic, or the index when the topic is missing or unknown.

topics()

@spec topics() :: [%{name: String.t(), title: String.t()}]

Returns the built-in help topic names and titles.