Add website and move examples to the top level

promptware · Nov 15, 2024 · b220168 · b220168
1 parent ae8d5f6
commit b220168
Show file tree

Hide file tree

Showing 10 changed files with 69 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ any other output]
 ```
 
 
-See [`python/examples/`](./python/examples/) for more.
+See [`examples/`](./examples/) for more.
 
 ## Project status
 
@@ -69,7 +69,7 @@ This is an early work-in-progress. Follow [me on twitter](https://x.com/klntsky)
     - [ ] llama
 - [ ] Runtime system
   - [x] Support variable definition at runtime
-  - [x] dynamic model switching (via `MODEL` variable - [example](./python/examples/model-change.metaprompt))
+  - [x] dynamic model switching (via `MODEL` variable - [example](./examples/model-change.metaprompt))
   - [ ] Multiple chat instances and ability to switch between them, to distribute data between chat contexts. E.g. `[$chat1: the object is the moon][$chat2: the object is the sun][$chat1: what is the object?]`
   - [ ] exceptions
     - [ ] throwing exceptions

diff --git a/docs/syntax.md b/docs/syntax.md
@@ -84,7 +84,7 @@ Normally, you would not need escaping, e.g. `[:foo` will evaluate to `[:foo` as
 
 `\\[:foo]` → (text `\\`) (variable `foo`)
 
-`\[some text` -> (text `[some text`) - note that in this case the `\` character disappears, although escaping does not happen because `[some text` not a special MetaPrompt construct.
+`\[some text` -> (text `[some text`) - note that in this case the `\` character disappears, although escaping does not happen because `[some text` is not a special MetaPrompt construct.
 
 # Modules
 

diff --git a/python/examples/choose-model.metaprompt → examples/choose-model.metaprompt b/python/examples/choose-model.metaprompt → examples/choose-model.metaprompt
diff --git a/python/examples/counter.metaprompt → examples/counter.metaprompt b/python/examples/counter.metaprompt → examples/counter.metaprompt
diff --git a/python/examples/dummy.metaprompt → examples/dummy.metaprompt b/python/examples/dummy.metaprompt → examples/dummy.metaprompt
diff --git a/python/examples/model-change.metaprompt → examples/model-change.metaprompt b/python/examples/model-change.metaprompt → examples/model-change.metaprompt
diff --git a/.../examples/model-selection-demo.metaprompt → examples/model-selection-demo.metaprompt b/.../examples/model-selection-demo.metaprompt → examples/model-selection-demo.metaprompt
diff --git a/python/examples/variables.metaprompt → examples/variables.metaprompt b/python/examples/variables.metaprompt → examples/variables.metaprompt
diff --git a/python/examples/whoami.metaprompt → examples/whoami.metaprompt b/python/examples/whoami.metaprompt → examples/whoami.metaprompt
diff --git a/website/index.html b/website/index.html
@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+
+    <!-- Google tag (gtag.js) -->
+    <script async src="https://www.googletagmanager.com/gtag/js?id=G-15CL0QJC3B"></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+
+      gtag('config', 'G-15CL0QJC3B');
+    </script>
+
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width,initial-scale=1" />
+    <title>MetaPrompt</title>
+    <style type="text/css">
+      body{
+          margin:40px auto;
+          font-family: monospace;
+          max-width:650px;
+          line-height:1.6;
+          font-size:18px;
+          color:#444;
+          padding:0 10px;
+      }
+      h1, h2, h3 {
+          line-height: 1.2;
+      }
+    </style>
+  </head>
+  <body>
+    <h1>
+      Hello, [:stranger_name]!
+    </h1>
+    <p>
+      This page is about MetaPrompt, a template engine for LLM prompts that supports writing prompts with prompts.
+    </p>
+    <h1>Project status
+    </h1>
+    <p>
+      Early work-in-progress. Not all of the described features have been implemented.
+    </p>
+    <h1>
+      Use cases
+    </h1>
+    <p>
+      <ul>
+        <li><b>Templating</b> - variable substitution</li>
+        <li><b>Prompt rewriting</b> - crafting prompts suitable for a given task based on a set of high-level rules, moderating input contents, or selecting the most suitable model for a task automatically</li>
+        <li><b>Prompt structuring</b> - using modules and packages to organize parameterized prompts</li>
+        <li><b>Knowledge base maintenance</b> - store your handcrafted prompts and include them conditionally</li>
+        <li><b>AI agents</b> - interact with the outside world</li>
+      </ul>
+    </p>
+    <h1>
+      Links
+    </h1>
+    <ul>
+      <li><a href="https://github.com/promptware/metaprompt/tree/main/examples">Examples</a></li>
+      <li><a href="https://docs.metaprompt-lang.org/">Documentation</a></li>
+      <li><a href="https://github.com/promptware/metaprompt">Source code</a></li>
+    </ul>
+  </body>
+</html>