docs: add project intro to readme and setup doc

This is a work in progress. Fixes: #165 Signed-off-by: Jaremy Hatler <hatler.jaremy@gmail.com>
jhatler · Jul 7, 2024 · 867adc6 · 867adc6
1 parent 2f69d2e
commit 867adc6
Show file tree

Hide file tree

Showing 16 changed files with 289 additions and 0 deletions.
diff --git a/.markdown-lint.yml b/.markdown-lint.yml
@@ -0,0 +1,35 @@
+---
+###########################
+###########################
+## Markdown Linter rules ##
+###########################
+###########################
+
+# Linter rules doc:
+# - https://github.com/DavidAnson/markdownlint
+#
+# Note:
+# To comment out a single error:
+#   <!-- markdownlint-disable -->
+#   any violations you want
+#   <!-- markdownlint-restore -->
+#
+
+###############
+# Rules by id #
+###############
+MD004: false # Unordered list style
+MD007:
+  indent: 2 # Unordered list indentation
+MD013: false # Line length 80 is far too short
+MD026:
+  punctuation: ".,;:!。，；:" # List of not allowed
+MD029: false # Ordered list item prefix
+MD033: false # Allow inline HTML
+MD036: false # Emphasis used instead of a heading
+MD045: false # Alt-text isn't needed
+
+#################
+# Rules by tags #
+#################
+blank_lines: false # Error on blank lines
diff --git a/README.md b/README.md
@@ -10,6 +10,31 @@
 [![SLSA 3](https://slsa.dev/images/gh-badge-level3.svg)](https://slsa.dev)
 <!-- editorconfig-checker-enable -->
 
+> [!WARNING]
+> This project is early days and under very active development in order to bootstrap the core functionality. Some of the information below is aspirational until the first beta release.
+
+Janus is a cybernetics project, aimed at becoming a self-replicating, self-operating, adaptive AI assistant. Its capabilities focus on managing complex cloud infrastructure and business operations (Accounts Receivable, Accounts Payable, Financial Reporting, DevSecOps, Corporate IT Service Management, etc.). It’s targeted at supporting SaaS products, startups, growth hackers, and software engineering teams within larger enterprises.
+
+Project Janus builds upon the many recent developments in generative AI. It can be thought of as a cloud-native Operating System that makes it accessible to delegate business activities to AI workers, each a distinct fork of the project. It provides the capabilities to train those AI workers to specialize within the organization running them or to a specific problem domains. Networking multiple workers together into teams to solve more complex problems (pulling in humans where desired/needed) is a primary design goal.
+
+The scaling limitations of incorporating AI workers into an organization will rapidly diminish as it reduces the overhead of understanding, operating, and training them. The iteration seen in the DevSecOps space over the last 20+ years has created a very mature foundation of automation which addresses these challenges. Coupling that automation with generative AI allows for the creation of complex digital systems that require little-to-no human intervention in order to operate and scale. Project Janus includes a complete Internal Development Platform (IDP). Beyond supporting the project community, the each IDP instance is accessible to the AI worker it corresponds to, allowing them to maintain, update, and operate their own systems.
+
+> [!NOTE]
+> A full project roadmap and more detailed documentation around the current state of functionality will be added over the coming weeks (penned 2024-07-05).
+
+
+## Getting Started
+
+In order to get started with your own fork of Project Janus it will be necessary to sign up for the following services. Each service either has a free usage tier or only charges for the resources consumed, so you will need a valid email and payment method in order to complete the setup process.
+
+- [GitHub](https://github.com/)
+- [Amazon Web Services](https://aws.amazon.com/)
+- [Spacelift](https://spacelift.io/)
+- [Infracost](https://www.infracost.io/)
+- [Aikido](https://www.aikido.dev/)
+
+When you're ready to fork the project you can follow these [step-by-step instructions](docs/SETUP.md). If you encounter any difficulties open a GitHub issue for support.
+
 ## Join the Community
 
 - [Code of Conduct](CODE_OF_CONDUCT.md)

diff --git a/docs/SETUP.md b/docs/SETUP.md
diff --git a/docs/img/StartforfreeGS.png b/docs/img/StartforfreeGS.png
diff --git a/docs/img/Startoptions.png b/docs/img/Startoptions.png
diff --git a/docs/img/actions-secrets-setup.png b/docs/img/actions-secrets-setup.png
diff --git a/docs/img/actions-secrets-tab.webp b/docs/img/actions-secrets-tab.webp
diff --git a/docs/img/aws-add-first-role.png b/docs/img/aws-add-first-role.png
diff --git a/docs/img/aws-add-integration.png b/docs/img/aws-add-integration.png
diff --git a/docs/img/create-api-key-button.png b/docs/img/create-api-key-button.png
diff --git a/docs/img/create-api-key-drawer.png b/docs/img/create-api-key-drawer.png
diff --git a/docs/img/create_fork.png b/docs/img/create_fork.png
diff --git a/docs/img/iam-create-role.png b/docs/img/iam-create-role.png
diff --git a/docs/img/organization-settings.png b/docs/img/organization-settings.png
diff --git a/docs/img/repo-actions-settings.webp b/docs/img/repo-actions-settings.webp
diff --git a/docs/img/start_fork.png b/docs/img/start_fork.png