Skip to content

[Docs] Reorganizing docs #1055

@Amir-R25

Description

@Amir-R25

Issue Categorization

  • Missing documentation
  • Incorrect or outdated information
  • Overly verbose or complex explanation
  • Broken links or formatting
  • Missing code examples
  • Typos or grammar issues

Documentation Problem

This will be a parent ticket to track my work on revamping our documentation based on the feedback provided from users.

Here are a few potential issues we would like to address:

  • Mkdocs 1.X is unmaintained. We use Material for Mkdocs which currently only works on Mkdocs 1.X: https://squidfunk.github.io/mkdocs-material/blog/2026/02/18/mkdocs-2.0/
  • Currently our docs assume familiarity with agents, APIs, environment variables, etc. While we need to set the limit at a certain technical expertise, we would like to be welcoming of most backgrounds
  • A lot of topics feel repeated
  • General theme and feel of the docs is feeling outdated
  • We need better handling of code snippets (this is one of the most difficult points to address)
  • ?

Metadata

Metadata

Assignees

Labels

docsThis issue is related to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions