docs: add projects page, more examples and 'powered by gptme' badge

- Add new projects.rst page showcasing gptme-powered projects
- Add 'powered by gptme' badge to README
- Move demos under examples section
- Add more examples to examples.rst
- Improve documentation organization

README.md

@@ -45,6 +45,10 @@
   <a href="https://x.com/gptmeorg">
     <img src="https://img.shields.io/twitter/follow/gptmeorg?style=social" alt="X.com" />
   </a>
+  <br>
+  <a href="https://gptme.org/docs/projects.html">
+    <img src="https://img.shields.io/badge/powered%20by-gptme%20%F0%9F%A4%96-5151f5?style=flat" alt="Powered by gptme" />
+  </a>
 </p>
 
 <p align="center">

docs/examples.rst

@@ -21,17 +21,32 @@ To see example output without running the commands yourself, check out the :doc:
     make test | gptme 'fix the failing tests'
 
     # if path not directly provided in prompt, it can read files using tools
-    gptme 'suggest improvements to my vimrc'
+    gptme 'explore'
     gptme 'take a screenshot and tell me what you see'
+    gptme 'suggest improvements to my vimrc'
 
     # can read URLs (if browser tool is available)
     gptme 'implement this' https://github.com/ErikBjare/gptme/issues/286
 
+    # can use `gh` shell tool to read issues, PRs, etc.
+    gptme 'implement ErikBjare/gptme/issues/286'
+
+    # create new projects
+    gptme 'create a performant n-body simulation in rust'
+
     # chaining prompts
+    gptme 'make a change' - 'test it' - 'commit it'
     gptme 'show me something cool in the python repl' - 'something cooler' - 'something even cooler'
 
 Do you have a cool example? Share it with us in the `Discussions <https://github.com/ErikBjare/gptme/discussions>`_!
 
+.. toctree::
+   :maxdepth: 2
+   :caption: More Examples
+
+   demos
+   projects
+
 
 .. rubric:: Skip confirmation and run in non-interactive mode
 

docs/index.rst

@@ -20,7 +20,6 @@ See the `README <https://github.com/ErikBjare/gptme/blob/master/README.md>`_ fil
 
    getting-started
    examples
-   demos
    tools
    config
    providers

docs/projects.rst

@@ -0,0 +1,67 @@
+Projects
+========
+
+This page lists projects that are powered by or built using gptme.
+
+Official Projects
+-----------------
+
+* `gptme <https://github.com/ErikBjare/gptme>`_
+    gptme itself, of course!
+
+* `gptme-agent-template <https://github.com/ErikBjare/gptme-agent-template>`_
+    Template for creating new agents powered by gptme.
+
+* `Bob <https://github.com/TimeToBuildBob>`_
+    The first agent built using the gptme agent architecture.
+
+* `gptme-rag <https://github.com/ErikBjare/gptme-rag>`_
+    RAG (Retrieval-Augmented Generation) implementation for gptme context management.
+
+* `gptme-webui <https://github.com/ErikBjare/gptme-webui>`_
+    Fancy web-based user interface for gptme, built with the help of `Lovable <https://lovable.dev/>`_.
+
+Community Projects
+------------------
+
+*Your project could be here! Add it by creating a PR.*
+
+* `ErikBjare/nbody-sim <https://github.com/ErikBjare/nbody-sim>`_
+    Simple but performant n-body simulation in Rust built with gptme using only a few prompts.
+
+
+.. rubric:: Adding Your Project
+
+
+If you've built something using gptme, we'd love to feature it here!
+
+1. Add the "Built with gptme" badge to your README:
+
+   .. code-block:: markdown
+
+      [![built using gptme](https://img.shields.io/badge/built%20using-gptme%20%F0%9F%A4%96-5151f5?style=flat)](https://github.com/ErikBjare/gptme)
+
+2. Create a PR adding your project to this list:
+
+   .. code-block:: rst
+
+      * `Project Name <https://github.com/username/project>`_
+          Brief description of your project.
+
+.. rubric:: Built with gptme Badge
+
+The "Built with gptme" badge helps showcase your project's use of gptme and connects it to the broader ecosystem.
+
+Standard Badge (for projects built using gptme):
+
+.. image:: https://img.shields.io/badge/built%20using-gptme%20%F0%9F%A4%96-5151f5?style=flat
+   :target: https://github.com/ErikBjare/gptme
+   :alt: Built using gptme
+
+"Powered by" Variant (for tools/services running on gptme):
+
+.. image:: https://img.shields.io/badge/powered%20by-gptme%20%F0%9F%A4%96-5151f5?style=flat
+   :target: https://github.com/ErikBjare/gptme
+   :alt: Powered by gptme
+
+Use the standard badge for projects created with gptme's assistance, and the "powered by" variant for tools or services that run on gptme.