Skip to content

README.md

Latest commit

 

History

History
23 lines (19 loc) · 2.89 KB

README.md

File metadata and controls

23 lines (19 loc) · 2.89 KB
Raw

Documentation Index

Living index of project documentation in /docs.

public-api.md is the canonical entrypoint for stable extension surfaces. Focused documents exist only when a surface has enough runtime rules to need a dedicated standard.

Documents

  • architecture.md — Overview of the Telegram bridge runtime, optional profile isolation, queueing model, native Rich Markdown delivery, UI/compat rendering, and interactive controls
  • public-api.md — Stable public API map: package entrypoints, commands, config, assistant markup, extension APIs, smoke examples, and compatibility boundaries
  • delivery.md — Target-aware companion delivery contract for operational views, logical message handles, target scopes, lifecycle fencing, and leader/follower transport
  • activity.md — Normalized Pi lifecycle API for extension-owned reasoning, intermediate prose, tool activity, source identity, delivery contexts, and consumer policy examples
  • ../.agents/skills/telegram-bot/SKILL.md — Agent-facing Telegram Bot API lookup skill backed by a local full Bot API reference
  • ../.agents/skills/domain-dag/SKILL.md — Project-local Domain DAG architecture skill and validator guidance
  • command-templates.md — Portable command-template standard core
  • inbound.md — Local pi-telegram inbound text/media handler bus, programmatic inbound handlers, registered STT provider fallbacks, legacy attachmentHandlers compatibility, placeholders, and fallbacks
  • outbound.md — Local pi-telegram outbound-handler config, text/voice/button behavior, single-artifact Rich results, voice synthesis provider fallback priority, artifact outputs, and callback routing
  • callback-namespaces.md — Shared Telegram callback_data namespace standard for layered extensions
  • updates.md — Update classification and runtime handler registry that lets layered extensions observe and consume Telegram updates without owning their own polling connection
  • multi-instance-bus.md — Optional multi-instance Telegram bus architecture: profile-scoped transport, leader/follower routing, thread targets, instance slots, manual follower registration, and recovery semantics
  • sections.md — Telegram Extension Sections Standard: registration contract, context ports, callback routing, navigation hierarchy, and demo reference for pi extensions that want Telegram UI surfaces
  • voice.md — Voice integration guide: detection, reply policy, STT/TTS provider registration, provider-owned conversion, and transparent interception
  • ui-style.md — Inline UI style guide for buttons, toggles, tabs, option lists, cards, and dialogs