@feat/narrative

Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 gem "jekyll", "~> 4.4.1"
 gem "just-the-docs", "0.10.1"
+gem "bigdecimal"

Gemfile.lock

@@ -4,6 +4,7 @@ GEM
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     base64 (0.2.0)
+    bigdecimal (3.1.9)
     colorator (1.1.0)
     concurrent-ruby (1.3.5)
     csv (3.3.2)
@@ -15,9 +16,7 @@ GEM
     ffi (1.17.1-x64-mingw-ucrt)
     ffi (1.17.1-x86_64-linux-gnu)
     forwardable-extended (2.6.0)
-    google-protobuf (3.25.7-arm64-darwin)
-    google-protobuf (3.25.7-x64-mingw-ucrt)
-    google-protobuf (3.25.7-x86_64-linux)
+    google-protobuf (3.25.7)
     http_parser.rb (0.8.0)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
@@ -90,6 +89,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  bigdecimal
   jekyll (~> 4.4.1)
   just-the-docs (= 0.10.1)
 

README.md

@@ -1,174 +1,17 @@
-# just-the-docs-template
+---
+title: About
+nav_order: 99
+nav_exclude: true
+---
 
-This is a *bare-minimum* template to create a [Jekyll] site that:
+# Introduction: What is Prometheus Swarm?
 
-- uses the [Just the Docs] theme;
-- can be built and published on [GitHub Pages];
-- can be built and previewed locally, and published on other platforms.
+Prometheus Swarm is an open-source AI platform that uses a "swarm" of intelligent agents running on a decentralized network (Koii) to build software from natural language descriptions. This technology aims to **change the world** by democratizing software development, enabling anyone to turn ideas into reliable applications.
 
-More specifically, the created site:
+Imagine thousands of AI agents working in parallel across Koii's global network of over 100,000 community-run computers. They produce code in real time, making Prometheus potentially "the first AI capable of anything" in software creation.
 
-- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem;
-- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages.
-
-To get started with creating a site, simply:
-
-1. click "[use this template]" to create a GitHub repository
-2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions
-
-If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](#hosting-your-docs-from-an-existing-project-repo).
-
-After completing the creation of your new site on GitHub, update it as needed:
-
-## Replace the content of the template pages
-
-Update the following files to your own content:
-
-- `index.md` (your new home page)
-- `README.md` (information for those who access your site repo on GitHub)
-
-## Changing the version of the theme and/or Jekyll
-
-Simply edit the relevant line(s) in the `Gemfile`.
-
-## Adding a plugin
-
-The Just the Docs theme automatically includes the [`jekyll-seo-tag`] plugin.
-
-To add an extra plugin, you need to add it in the `Gemfile` *and* in `_config.yml`. For example, to add [`jekyll-default-layout`]:
-
-- Add the following to your site's `Gemfile`:
-
-  ```ruby
-  gem "jekyll-default-layout"
-  ```
-
-- And add the following to your site's `_config.yml`:
-
-  ```yaml
-  plugins:
-    - jekyll-default-layout
-  ```
-
-Note: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
-
-## Publishing your site on GitHub Pages
-
-1.  If your created site is `YOUR-USERNAME/YOUR-SITE-NAME`, update `_config.yml` to:
-
-    ```yaml
-    title: YOUR TITLE
-    description: YOUR DESCRIPTION
-    theme: just-the-docs
-
-    url: https://YOUR-USERNAME.github.io/YOUR-SITE-NAME
-
-    aux_links: # remove if you don't want this link to appear on your pages
-      Template Repository: https://github.com/YOUR-USERNAME/YOUR-SITE-NAME
-    ```
-
-2.  Push your updated `_config.yml` to your site on GitHub.
-
-3.  In your newly created repo on GitHub:
-    - go to the `Settings` tab -> `Pages` -> `Build and deployment`, then select `Source`: `GitHub Actions`.
-    - if there were any failed Actions, go to the `Actions` tab and click on `Re-run jobs`.
-
-## Building and previewing your site locally
-
-Assuming [Jekyll] and [Bundler] are installed on your computer:
-
-1.  Change your working directory to the root directory of your site.
-
-2.  Run `bundle install`.
-
-3.  Run `bundle exec jekyll serve` to build your site and preview it at `localhost:4000`.
-
-    The built site is stored in the directory `_site`.
-
-## Publishing your built site on a different platform
-
-Just upload all the files in the directory `_site`.
-
-## Customization
-
-You're free to customize sites that you create with this template, however you like!
-
-[Browse our documentation][Just the Docs] to learn more about how to use this theme.
-
-## Hosting your docs from an existing project repo
-
-You might want to maintain your docs in an existing project repo. Instead of creating a new repo using the [just-the-docs template](https://github.com/just-the-docs/just-the-docs-template), you can copy the template files into your existing repo and configure the template's Github Actions workflow to build from a `docs` directory. You can clone the template to your local machine or download the `.zip` file to access the files.
-
-### Copy the template files
-
-1.  Create a `.github/workflows` directory at your project root if your repo doesn't already have one. Copy the `pages.yml` file into this directory. GitHub Actions searches this directory for workflow files.
-
-2.  Create a `docs` directory at your project root and copy all remaining template files into this directory.
-
-### Modify the GitHub Actions workflow
-
-The GitHub Actions workflow that builds and deploys your site to Github Pages is defined by the `pages.yml` file. You'll need to edit this file to that so that your build and deploy steps look to your `docs` directory, rather than the project root.
-
-1.  Set the default `working-directory` param for the build job.
-
-    ```yaml
-    build:
-      runs-on: ubuntu-latest
-      defaults:
-        run:
-          working-directory: docs
-    ```
-
-2.  Set the `working-directory` param for the Setup Ruby step.
-
-    ```yaml
-    - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.3'
-          bundler-cache: true
-          cache-version: 0
-          working-directory: '${{ github.workspace }}/docs'
-    ```
-
-3.  Set the path param for the Upload artifact step:
-
-    ```yaml
-    - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: docs/_site/
-    ```
-
-4.  Modify the trigger so that only changes within the `docs` directory start the workflow. Otherwise, every change to your project (even those that don't affect the docs) would trigger a new site build and deploy.
-
-    ```yaml
-    on:
-      push:
-        branches:
-          - "main"
-        paths:
-          - "docs/**"
-    ```
-
-## Licensing and Attribution
-
-This repository is licensed under the [MIT License]. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use!
-
-The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party [starter workflows]. A copy of their MIT License is available in [actions/starter-workflows].
-
-----
-
-[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
-
-[Jekyll]: https://jekyllrb.com
-[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
-[GitHub Pages]: https://docs.github.com/en/pages
-[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
-[Bundler]: https://bundler.io
-[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
-[`jekyll-default-layout`]: https://github.com/benbalter/jekyll-default-layout
-[`jekyll-seo-tag`]: https://jekyll.github.io/jekyll-seo-tag
-[MIT License]: https://en.wikipedia.org/wiki/MIT_License
-[starter workflows]: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml
-[actions/starter-workflows]: https://github.com/actions/starter-workflows/blob/main/LICENSE
+*   **What Prometheus Is:** Prometheus Swarm is an AI framework powered by decentralized compute. It orchestrates autonomous AI coding agents that collaboratively build, test, and deploy applications.
+*   **How It Works at High Level:** Thousands of distributed agents collaborate to write and improve code, continuously updating a Git repository in real time. The system supports multiple AI models (e.g., GPT-4, Claude) and employs modular tool-chaining.
+*   **Why It Matters:** This is a breakthrough – anyone can build software by describing their idea, overcoming traditional skill barriers. Prometheus Swarm promises to **empower creators and teams** to build solutions faster and more cost-efficiently than ever, heralding a new era of AI-driven development.
+*   **Open-Source and Community:** The project is completely open source with an active community. You can find all code and ongoing development at the GitHub organization: [Prometheus-Swarm](https://github.com/Prometheus-Swarm). This transparency invites developers to inspect code or contribute, reinforcing trust.
+*   **Call to Action:** Explore further or **Try Prometheus Swarm** (link to official site/quick start needed) now that you grasp its significance.

_config.yml

@@ -10,9 +10,107 @@ color_scheme: "prometheus"
 logo: "/assets/images/logo.svg"
 favicon_ico: "/assets/images/favicon.svg"
 
+# Define collections for navigation structure
+collections:
+  # Introduction (README.md at root)
+  introduction:
+    output: true
+    permalink: /:collection/:path/
+  # Our Origin Story section
+  about:
+    output: true
+    permalink: /:collection/:path/
+  # Guides section
+  guides:
+    output: true
+    permalink: /:collection/:path/
+  # How it works section
+  how-it-works:
+    output: true
+    permalink: /:collection/:path/
+  # Existing docs content (preserved)
+  docs:
+    output: true
+    permalink: /:collection/:path/
+
+# Set the order of collections in navigation
+collections_dir: .
+nav_sort: case_sensitive
+
+# Just the Docs navigation settings
+aux_links:
+  "Prometheus Swarm on GitHub":
+    - "//github.com/Prometheus-Swarm"
+
+# Exclude these files from being included in collections
+exclude:
+  - .sass-cache/
+  - .jekyll-cache/
+  - gemfiles/
+  - Gemfile
+  - Gemfile.lock
+  - node_modules/
+  - vendor/
+
+# Include folders that Jekyll might otherwise ignore
+include:
+  - about
+  - guides
+  - how-it-works
+
+# Default settings for pages
 defaults:
+  # Root pages (like README.md)
+  - scope:
+      path: ""
+      type: pages
+    values:
+      layout: "default"
+  # Introduction collection (should include README.md)
+  - scope:
+      path: ""
+      type: introduction
+    values:
+      layout: "default"
+      nav_order: 1
+  # About collection
+  - scope:
+      path: "about"
+      type: about
+    values:
+      layout: "default"
+      nav_order: 2
+  # Guides collection
+  - scope:
+      path: "guides"
+      type: guides
+    values:
+      layout: "default"
+      nav_order: 3
+  # How it works collection
+  - scope:
+      path: "how-it-works"
+      type: how-it-works
+    values:
+      layout: "default"
+      nav_order: 4
+  # Docs collection (existing content)
   - scope:
       path: "docs"
-      type: "pages"
+      type: docs
     values:
       layout: "default"
+      nav_order: 5
+
+# collections: # This was a thought, but holding off for now.
+# main_docs:
+# output: true
+# order:
+#       - README.md
+#       - about/origin.md
+#       - guides/for-creators.md
+#       - guides/for-developers.md
+#       - guides/for-enterprise.md
+#       - how-it-works/architecture.md
+#       - how-it-works/usage-process.md
+#       - how-it-works/quality-assurance.md

about/origin.md

@@ -0,0 +1,14 @@
+---
+title: Our Origin Story
+nav_order: 2
+---
+
+# Our Origin Story: From Myth to Innovation
+
+Prometheus Swarm draws its name and inspiration from the Greek myth of Prometheus, the titan who gifted fire – a powerful, transformative technology – to humanity. Similarly, Prometheus Swarm aims to give the "fire" of AI-driven software development capabilities to everyone, democratizing creation.
+
+*   **Mythical Inspiration:** Just as Prometheus brought fire to empower humans, Prometheus Swarm brings powerful AI-driven development tools to all creators. The platform's mission is to empower and transform the world of software creation by democratizing access to this "creative fire."
+*   **Koii Team & Background:** The project was conceived and built by Al Morris and the Koii Network team. Koii Network is a decentralized compute network with approximately 100,000+ community-run nodes, built on a philosophy of open development and incentive design. This robust, distributed infrastructure and expertise in decentralized systems form the foundation upon which Prometheus Swarm is built.
+*   **Genesis of the Idea:** The idea for Prometheus Swarm emerged from tackling real-world challenges in early AI-assisted coding. The team's initial experiments with "vibe coding" (using AI to generate code from natural language) were promising but often resulted in error-prone and unreliable applications. This spurred the determination to invent a more rigorous, industrialized, and modular workflow that could reliably turn ideas into working software, addressing common AI pitfalls like "hallucinations." Prometheus Swarm officially launched in early 2025, with support from the Koii Foundation, as a solution to these problems.
+*   **Milestones & Alliances:** Key milestones include the mainnet launch on January 3, 2025. Within weeks, Prometheus Swarm had already partnered with over 50 projects, demonstrating strong early adoption and validating the demand for AI-generated software at scale. The project continues to foster community engagement through meetups and collaborations, such as with Swarms.ai.
+*   **Vision Statement:** The long-term vision is a future where building software is as accessible as telling a story. Prometheus Swarm, through its union of mythic ambition and practical innovation, strives to make this a reality. The ethos from day one has been open-source and community-first: "everything we do is open source…you're welcome to pivot on it, take it your own direction."