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

EPIC - Framework Docs Site #297

Open
9 tasks
mmurad2 opened this issue Jan 27, 2025 · 0 comments
Open
9 tasks

EPIC - Framework Docs Site #297

mmurad2 opened this issue Jan 27, 2025 · 0 comments
Assignees
Labels
python Python related functionality typescript Typescript related functionality

Comments

@mmurad2
Copy link
Member

mmurad2 commented Jan 27, 2025

Description

This Epic focuses on improving and releasing an updated version of the framework documentation as a standalone docs site. The goal is to ensure that developers can easily understand and implement the framework, reducing onboarding time and support requests.

User story: As a developer, I want clear, comprehensive, and up-to-date documentation so that I can easily get started and effectively use the framework.

Initiative / goal

Lower friction to get started / get to value
Related Epic: EPIC - Dev landing page + docs #93

Acceptance criteria and must have scope

Content reqs

  • Explain framework philosophy
  • Architectural diagram
  • Simplify navigation: agent core, dev tools, extensions, tutorials
  • Detailed explanation + code snippets

Functional reqs

  • Search by keyword (semantic search / chat with docs nice to have)
  • Toggle between different framework version docs
  • Similar structure and nav between Py and TS version of the framework
  • Sync with github, link to edit on github

IA/Nav

  • Define how the IA for framework related to the platform

Timeline

March 14 target

@mmurad2 mmurad2 moved this to Now in BeeAI Roadmap Feb 17, 2025
@mmurad2 mmurad2 changed the title EPIC - Framework Docs EPIC - Framework Docs Site Feb 17, 2025
@mmurad2 mmurad2 moved this from Now to Next in BeeAI Roadmap Feb 17, 2025
@mmurad2 mmurad2 moved this from Next to Target for this month in BeeAI Roadmap Feb 17, 2025
@mmurad2 mmurad2 moved this from Now to Next in BeeAI Roadmap Feb 17, 2025
@Tomas2D Tomas2D added typescript Typescript related functionality python Python related functionality labels Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
python Python related functionality typescript Typescript related functionality
Projects
Status: Next
Development

No branches or pull requests

3 participants