Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define skeleton of docs #226

Open
tomkis opened this issue Feb 28, 2025 · 1 comment
Open

Define skeleton of docs #226

tomkis opened this issue Feb 28, 2025 · 1 comment
Assignees

Comments

@tomkis
Copy link
Collaborator

tomkis commented Feb 28, 2025

Define skeleton (for example as mindmap) of what has to be documented.

Draw inspiration from provided sources.

Content requirements ideas

Here are some of ideas for content requirements

  • How to install platform
  • How to use platform
  • How to wrap agent - this will be very simplistic as the concept of providers will likely change
  • How to contribute (draw inspiration from MCP)

IA: https://app.mural.co/t/ibmresearchdesign6459/m/ibmresearchdesign6459/1739817117981/967e9f0a46b38c169feef03ba9a8c5a04d961206?sender=ubf66640e3eb42e4863417297

Inspirations

@matoushavlena
Copy link
Contributor

Proposal:

  • Introduction

    • 🚧 Quickstart
    • 🚧 Installation
    • Changelog
    • Tutorials (overlaps with How to Guides)
    • Roadmap
    • FAQ
  • How to Guides

    • ❗ Use agents
      • CLI, UI, REST, Python, TypeScript, import from github?
      • inference setup / model management
      • env setup / config
    • Compose agents
    • ❗ Contribute / create agents
      • Python, TS, docker
      • Add custom provider
      • Agent implementation
      • Progress notification / streaming
      • Debug
  • Agent library

    • ✅ Official
    • ✅ Community
  • Concepts

    • ❗ Overall architecture
      • CLI, server, UI, diagram
    • ❗ Agents
      • Agent types (chat, hands-off, custom, schemas)
    • ❗ Providers (Radek)
      • Manifest, Managed/Unmanaged, Lifecycle, Regsitry
    • Tools
  • ✅ Agent Communication Protocol

    • ...
    • SDK
  • Telemetry / Observability

    • Telemetry

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants