Skip to content

Contributing

Thank you for considering contributing to Griptape documentation! Before you start, please read the following guidelines.

Submitting Issues

If you have identified a documentation issue, want to propose new documentation, or have a question, please submit an issue through our public issue tracker. Before submitting a new issue, please check the existing issues to ensure it hasn't been reported or discussed before.

Submitting Pull Requests

We welcome and encourage pull requests. To streamline the process, please follow these guidelines:

  1. Existing Issues: Please submit pull requests only for existing issues. If you want to add new documentation or fix a documentation issue that hasn't been addressed yet, please first submit an issue. This allows the Griptape team to internally process the request and provide a public response.

  2. Branch: Submit all pull requests to the dev branch. This helps us manage changes and integrate them smoothly.

Getting Started

Griptape docs are built using MkDocs. Dependencies are managed using Poetry.

To directly contribute to Griptape documentation, first fork the griptape-docs repository to your GitHub account. Then clone your repository to your local machine.

From inside the directory run:

poetry install --with docs

To run griptape-docs locally run:

poetry run mkdocs serve

You should see something similar to the following: 

INFO     -  Building documentation...
INFO     -  Cleaning site directory
INFO     -  Documentation built in 0.19 seconds
INFO     -  [09:28:33] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO     -  [09:28:33] Serving on http://127.0.0.1:8000/
INFO     -  [09:28:37] Browser connected: http://127.0.0.1:8000/

Reference Docs

You may see many WARNING messages in the console output. This is because the reference docs are not built. Fixing this is not necessary to contribute to the documentation, but it helps to reduce noise in the console output.

First, clone the Griptape repository to a separate directory:

git clone git@github.com:griptape-ai/griptape.git ~/some/other/directory/

Then, create a symlink called griptape in the griptape-docs repository:

ln -s ~/some/other/directory/griptape griptape

The WARNING messages should now be resolved.