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

chore: create mkdocs for goose #70

Merged
merged 19 commits into from
Sep 17, 2024
Merged

chore: create mkdocs for goose #70

merged 19 commits into from
Sep 17, 2024

Conversation

lily-de
Copy link
Collaborator

@lily-de lily-de commented Sep 17, 2024

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.

@lily-de lily-de marked this pull request as ready for review September 17, 2024 16:47
pyproject.toml Outdated Show resolved Hide resolved

**Usage:**
```sh
goose session resume [NAME] [--profile PROFILE]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't remember if this exists, but if the profile doesn't have toolkits that were used in the session, there is potential for errors in the session. Maybe we put a warning here of this usage.

docs/docs/configuration.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated
Comment on lines 3 to 12
<p align="center">
<a href="#prerequisites">Prerequisites</a> •
<a href="#evaluations">Evaluations</a> •
<a href="#developing-and-testing">Developing and testing</a> •
<a href="#building-from-source">Building from source</a> •
<a href="#developing-goose-plugins">Developing goose-plugins</a> •
<a href="#running-ai-exchange-from-source">Running ai-exchange from source</a> •
<a href="#evaluations">Evaluations</a> •
<a href="#conventional-commits">Conventional Commits</a>
</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This being centered throws be a bit off.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

was trying to save vertical space lol -- but don't disagree

CONTRIBUTING.md Outdated
**When to Add to Goose-Plugins:**

* Lighter Scrutiny: Plugins in goose-plugins undergo less thorough reviews compared to Goose. This repository is intended for more modular, optional, or experimental plugins that may not be critical to Goose’s core functionality.
* General, Reusable Plugins: If the plugin could be useful in a variety of contexts or is designed to extend Goose in a more optional way, it belongs in goose-plugins. This allows for faster iteration and easier contributions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General, Reusable Plugins: If the plugin could be useful in a variety of contexts

I'm not sure if this is exactly correct - I think the difference is instead that plugins in Goose have to show value (via out eventual benchmarking performance), whereas ones in Goose-Plugins can be a bit more experimental and prove their worth there.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Edited! lmk if that's better. Struggled with articulating this

docs/docs/toolkits.md Show resolved Hide resolved
docs/docs/configuration.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@zakiali zakiali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good! Happy to get this in and iterate

@lily-de lily-de merged commit 10cf507 into main Sep 17, 2024
2 checks passed
Kvadratni added a commit to Kvadratni/goose that referenced this pull request Sep 23, 2024
* origin/main:
  docs: add in ollama (block#82)
  chore: add just command for releasing goose (block#55)
  feat: support markdown plans  (block#79)
  feat: add version options (block#74)
  docs: fixing exchange url to public version (block#67)
  docs: Update CONTRIBUTING.md (block#69)
  chore: create mkdocs for goose (block#70)
  docs: fix broken link (block#71)
  feat: give commands the ability to execute logic (block#63)
  feat: jira toolkit (block#59)
  feat: run goose in a docker-style sandbox (block#44)
lily-de added a commit that referenced this pull request Oct 7, 2024
@lamchau lamchau deleted the ldelalande/create-mkdocs branch October 24, 2024 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants