Skip to content

Create Documentation Website with mkdocs and GitHub Pages #1

@leandermaben

Description

@leandermaben

Set up a documentation website for the project using react and host it via GitHub Pages. Put all code under a docs directory. The site should include sections for installation, agents, actions, contributing, launching the UI, reproducing training results, architecture (with updated diagram), and any other relevant project details. Each section should be maintained in Markdown under a docs directory.

  • Add instructions to the repo for local development and deployment of the docs site.
  • Ensure the main README includes a prominent link/button to the new docs site.
  • Use the latest diagram image1 in the architecture section.
  • Organize content so contributor and advanced usage material is on the docs site, while the README remains focused on overview, installation, and key links.
  • Optionally, customize the website's theme and add navigation for ease of use.

Action items:

  • Initialize mkdocs (or similar) for documentation
  • Build docs structure and add initial content
  • Deploy site with GitHub Pages
  • Update README to link to docs site

Suggestions for further improvements are welcome.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions