Skip to content

Commit

Permalink
docs: fixed automation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikBjare committed Oct 2, 2024
1 parent 52baf5b commit a70b5b5
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 15 deletions.
19 changes: 7 additions & 12 deletions docs/automation.rst
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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 <url>' '-' '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
2 changes: 1 addition & 1 deletion docs/automation/example_activity_summary.rst
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
4 changes: 2 additions & 2 deletions docs/automation/example_code_review.rst
Original file line number Diff line number Diff line change
@@ -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.

Expand Down

0 comments on commit a70b5b5

Please sign in to comment.