Skip to content

Commit ff3d2b6

Browse files
authored
docs: improve overview page (#1832)
docs: update contributing guide docs: simplify docs landing page docs: add light/dark mode toggle docs: move recipes into framework section docs: rename examples to recipes docs: improve README docs: improve docs landing page docs: improve framework overview docs: categorize driver nav links docs: move recipes into framework section
1 parent 0cf3322 commit ff3d2b6

55 files changed

Lines changed: 1026 additions & 424 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 147 additions & 114 deletions
Large diffs are not rendered by default.

docs/contributing.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,11 @@
11
# Contributing
22

3-
Thank you for considering contributing to Griptape documentation! Before you start, please read the following guidelines.
4-
5-
## Submitting Issues
6-
7-
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](https://github.com/griptape-ai/griptape/issues). Before submitting a new issue, please check the existing issues to ensure it hasn't been reported or discussed before.
8-
9-
## Submitting Pull Requests
10-
11-
We welcome and encourage pull requests. To streamline the process, please follow these guidelines:
12-
13-
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.
14-
15-
1. **Branch:** Submit all pull requests to the `dev` branch. This helps us manage changes and integrate them smoothly.
3+
Thank you for considering contributing to Griptape documentation! Before you start, please read our [contributing guidelines](https://github.com/griptape-ai/griptape/blob/main/CONTRIBUTING.md).
164

175
## Getting Started
186

19-
Griptape docs are built using [MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started/). Dependencies are managed using [uv](https://docs.astral.sh/uv/).
7+
Griptape docs are built using [MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started/).
8+
Dependencies are managed using [uv](https://docs.astral.sh/uv/).
209

2110
To contribute to Griptape docs, install the `docs` extra with:
2211

docs/examples/index.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/examples/load-and-query-pinecone.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/examples/load-query-and-chat-marqo.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/examples/query-webpage.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/griptape-framework/data/artifacts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,4 @@ When `ListArtifact`s are returned from Tools, their elements will be stored in [
5151

5252
## Generic
5353

54-
[GenericArtifact](../../reference/griptape/artifacts/generic_artifact.md)s provide a flexible way to pass data that does not fit into any other artifact category. While not generally recommended, they can be useful for specific use cases. For instance, see [talking to a video](../../examples/talk-to-a-video.md), which demonstrates using a `GenericArtifact` to pass a Gemini-specific video file.
54+
[GenericArtifact](../../reference/griptape/artifacts/generic_artifact.md)s provide a flexible way to pass data that does not fit into any other artifact category. While not generally recommended, they can be useful for specific use cases. For instance, see [talking to a video](../../recipes/talk-to-a-video.md), which demonstrates using a `GenericArtifact` to pass a Gemini-specific video file.

docs/griptape-framework/index.md

Lines changed: 311 additions & 178 deletions
Large diffs are not rendered by default.
Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
from griptape.structures import Agent
2-
from griptape.utils import Chat
1+
from griptape.tasks import PromptTask
32

4-
agent = Agent()
5-
Chat(agent).start()
3+
task = PromptTask()
4+
5+
output = task.run("Hello there!")
6+
7+
print(output)
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
from pydantic import BaseModel
2+
3+
from griptape.drivers.prompt.openai_chat_prompt_driver import OpenAiChatPromptDriver
4+
from griptape.memory.structure import ConversationMemory
5+
from griptape.rules import Rule, Ruleset
6+
from griptape.tasks import PromptTask
7+
8+
9+
class Output(BaseModel):
10+
answer: str
11+
12+
13+
task = PromptTask(
14+
input="You are speaking to: {{ user_name }}. User said: {{ args[0] }}",
15+
prompt_driver=OpenAiChatPromptDriver(model="gpt-4o"),
16+
context={"user_name": "Collin"},
17+
rulesets=[
18+
Ruleset(
19+
name="Backstory",
20+
rules=[
21+
Rule("Your name is Oswald."),
22+
],
23+
),
24+
Ruleset(
25+
name="Behavior",
26+
rules=[
27+
Rule("Introduce yourself at the start of the conversation."),
28+
],
29+
),
30+
],
31+
output_schema=Output,
32+
conversation_memory=ConversationMemory(),
33+
)
34+
35+
task.run("Hi there, my name is Collin!")
36+
task.run("Do you remember my name?")

0 commit comments

Comments
 (0)