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

Docs review #201

Closed
sirkitree opened this issue Nov 5, 2024 · 1 comment
Closed

Docs review #201

sirkitree opened this issue Nov 5, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@sirkitree
Copy link
Collaborator

Homepage

Image

  • ... designed to be and easy to use (strike the 'and')

Image

  • This discord invite is invalid.

Image

  • Just curious, but what is the "b" icon? Should we make like an AI one? or is this something to do with the docs framework?

API

  • In general, API docs typically have a standard format that provides the interface, parameters, endpoints, etc. for something like a REST API. So when clicking this, I was not expecting to see setup instructions. It seems like this is mostly duplicate info from the "Getting Started" section. There isn't really an API, so I'd suggest we just remove this section for now.
  • Possibly replace with with some documentation about how the core information flows from the Agent Runtime, to the Memory System, the Room-based Organization, Information Processing Pipeline, Provider Integration, and State Management - though these could all be valid sections under the Advanced Concepts section as well on the Documentation page.

Image

  • banner image is broken
@sirkitree sirkitree added this to Eliza Nov 5, 2024
@sirkitree sirkitree converted this from a draft issue Nov 5, 2024
@sirkitree sirkitree added the documentation Improvements or additions to documentation label Nov 5, 2024
@madjin
Copy link
Collaborator

madjin commented Nov 8, 2024

I did a huge overhaul of docs, still much more to do (looking around for a new icon/logo to replace that b)

https://ai16z.github.io/eliza/docs/intro/

Some to-do plans:

  • prettify overall (icons to table of contents)
  • add some architecture diagrams (LLM -> mermaid diagram)
  • improve api docs (make code more readable / add comments for better autodocs)
  • test and ensure documentation is up to date (go through everything after refactor code merges)
  • add more visuals

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

No branches or pull requests

2 participants