diff --git a/docs/automation.rst b/docs/automation.rst index f60a5b0a..275f4ba1 100644 --- a/docs/automation.rst +++ b/docs/automation.rst @@ -1,5 +1,5 @@ -Automation with gptme -===================== +Automation +========== gptme can be used to create powerful yet simple automated workflows. Here we showcase small but powerful examples that demonstrate the capabilities of gptme in various workflows and automation scenarios. @@ -12,23 +12,18 @@ We will be using shell scripts, cron jobs, and other tools to automate the workf -Example: script that implements feature ---------------------------------------- +Example: Implement feature +-------------------------- -This example demonstrates how to create a script that implements a feature using gptme. Given a GitHub issue it will check out a new branch, look up relevant files, make changes, typecheck/test them, and create a pull request. +This example demonstrates how to implement a feature in a codebase using gptme, making sure the code is correct before creating a pull request. + +Given a GitHub issue it will check out a new branch, look up relevant files, make changes, typecheck/test them, and create a pull request if everything is correct. .. code-block:: bash $ gptme 'read ' '-' 'create a branch' '-' 'look up relevant files' '-' 'make changes' '-' 'typecheck it' '-' 'test it' '-' 'create a pull request' -Example: Automated code review ------------------------------- - .. include:: automation/example_code_review.rst - -Example: Activity summary -------------------------- - .. include:: automation/example_activity_summary.rst diff --git a/docs/automation/example_activity_summary.rst b/docs/automation/example_activity_summary.rst index 5db69047..5e0f62a4 100644 --- a/docs/automation/example_activity_summary.rst +++ b/docs/automation/example_activity_summary.rst @@ -1,5 +1,5 @@ Example: Daily Activity Summary -=============================== +------------------------------- Here's an example of how to use gptme to generate a daily summary based on ActivityWatch data using a shell script: diff --git a/docs/automation/example_code_review.rst b/docs/automation/example_code_review.rst index df4036d4..270caaa6 100644 --- a/docs/automation/example_code_review.rst +++ b/docs/automation/example_code_review.rst @@ -1,5 +1,5 @@ -Example: Automated Code Review with gptme -========================================= +Example: Automated Code Review +------------------------------ This example demonstrates a simple and composable approach to automated code review using gptme and shell scripting.