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

Overhaul documentation to be more beginner-friendly #359

Open
bitbrain opened this issue Oct 25, 2024 · 0 comments
Open

Overhaul documentation to be more beginner-friendly #359

bitbrain opened this issue Oct 25, 2024 · 0 comments
Labels
📙 docs Improvements or additions to documentation 🌺 enhancement New feature or request

Comments

@bitbrain
Copy link
Owner

The current structure/docs are not great for people just wanting to get started. There has been a lot of feedback that people find the existing docs difficult to grasp.

One recommendation was streamlit that has great docs as a point of reference. Structuring the docs like so could be very beneficial:

  1. Getting started
    • Installation
    • Fundamentals
    • First Steps
  2. Develop
    • Beehave internals
    • Best practices
  3. API docs
    • actual API docs of beehave (built from source)
  4. Tutorials
    • various specific behaviour tree tutorials
    • video tutorials (from the community)
  5. Contribute
@bitbrain bitbrain added 📙 docs Improvements or additions to documentation 🌺 enhancement New feature or request labels Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📙 docs Improvements or additions to documentation 🌺 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant