search

block-open-source / goose

Goose is a developer agent that operates from your command line to help you do the boring stuff.
https://block-open-source.github.io/goose/
Apache License 2.0
73 stars 12 forks source link

chore: create mkdocs for goose #70

Closed lily-de closed 2 weeks ago

lily-de commented 2 weeks ago

Created a symlink between CONTRIBUTING.md (the one we should always update) and docs/docs/contributing.md (so changes are reflected ?)

  1. .gitignore: Modified to add/remove entries for various directories and files (e.g., removing MANIFEST, .pytest_cache, adding docs/_build/).
  2. CONTRIBUTING.md: Expanded to include detailed sections on prerequisites, developing and testing, creating plugins, running the project from source, evaluations, and adhering to Conventional Commits.
  3. Documentation: Added a new documentation structure (mkdocs.yml, index.md, installation.md, configuration.md, cli.md, toolkits.md). This includes new assets such as images and CSS/JS files to enhance appearance and functionality.
  4. Scripts: A new script (gen_ref_pages.py) to automate reference page generation for documentation.
  5. Justfile: Added a docs command to facilitate local documentation server setup.
  6. Dependencies: New dependencies (goose-plugins-block, setuptools) were added to pyproject.toml.