Saltar a contenido

rai docs

Gestiona documentación de gobernanza mediante adapters DocumentationTarget (filesystem, Confluence o ambos). Publica artifacts y recupera/busca documentación remota.

rai docs publish

Publica un artifact en un destino de documentación.

Argumento Descripción
ARTIFACT_TYPE Tipo de artifact, ej. roadmap, adr, epic-docs, session-diary (requerido)
Flag Corta Descripción
--title Título de la página (por defecto, el tipo de artifact)
--file -f Lee el contenido desde un archivo (omite la convención de governance/)
--path -p Ruta local para el destino filesystem (usado con --stdin)
--stdin Lee el contenido desde stdin (requiere --path)
--parent ID de página padre — reemplaza la configuración de enrutamiento
--target -t Nombre del destino (detección automática si se omite)

Fuentes de contenido (por orden de prioridad):

  1. --file PATH — leer desde un archivo existente
  2. --stdin — leer desde stdin (pipe o heredoc), requiere --path
  3. governance/{type}.md — convención por defecto
# Publicar desde la convención de gobernanza
rai docs publish roadmap
rai docs publish adr --title "ADR-001: Graph Architecture"

# Publicar desde cualquier archivo
rai docs publish epic-docs --title "E1064: Pipeline Engine" --file /tmp/epic-docs.md

# Reemplazar página padre (Confluence)
rai docs publish session-diary --title "Session Diary — 2026-04-06" --file /tmp/diary.md --parent 3067674642

# Publicar desde stdin
cat design.md | rai docs publish design --title "Auth Design" --path docs/design.md --stdin

Enrutamiento: Al publicar en Confluence, el adapter resuelve la página padre desde la configuración de enrutamiento en .raise/docs.yaml. El flag --parent reemplaza este valor. Consulta la Referencia de docs.yaml para el formato completo de configuración.

rai docs get

Recupera una página desde el destino de documentación.

Argumento Descripción
IDENTIFIER ID de página en el destino remoto (requerido)
Flag Corta Descripción
--target -t Nombre del destino 
rai docs get 12345678

Busca páginas de documentación en el destino remoto.

Argumento Descripción
QUERY Consulta de búsqueda (requerido)
Flag Corta Descripción
--limit -n Máximo de resultados. Por defecto: 10
--target -t Nombre del destino 
rai docs search "architecture decisions"
rai docs search "roadmap" -n 5

Ver también: rai adapter