@promptbook/documents 0.86.8 → 0.86.22

package/README.md

@@ -144,9 +144,7 @@ And **Promptbook.city** branded socials:
 _/Sub-brand for images and graphics generated via Promptbook prompting/_
 
 -   [Instagram `@promptbook.city`](https://www.instagram.com/promptbook.city/)
--   [Facebook `Promptbook City`](https://www.facebook.com/61565718625569) 
-
-## 
+-   [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
 
 
 
@@ -157,7 +155,9 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
 
 
 
-Following is the documentation and blueprint of the Book language.
+Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
+
+Book is a language that can be used to write AI applications, agents, workflows, automations, knowledgebases, translators, sheet processors, email automations and more. It allows you to harness the power of AI models in human-like terms, without the need to know the specifics and technicalities of the models.
 
 ### Example
 
@@ -165,35 +165,56 @@ Following is the documentation and blueprint of the Book language.
 # 🌟 My first Book
 
 -   BOOK VERSION 1.0.0
--   URL https://promptbook.studio/my-first-book/
+-   URL https://promptbook.studio/hello.book
+-   INPUT PARAMETER {topic}
+-   OUTPUT PARAMETER {article}
 
 # Write an article
 
 -   PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
--   KNOWLEDGE https://ptbk.io
--   KNOWLEDGE ./promptbook.pdf
+-   KNOWLEDGE https://wikipedia.org/
+-   KNOWLEDGE ./journalist-ethics.pdf
 -   EXPECT MIN 1 Sentence
--   EXPECT MAX 1 Paragraph
+-   EXPECT MAX 5 Pages
 
-> Write an article about the future of artificial intelligence in the next 10 years and how metalanguages will change the way AI is used in the world.
-> Look specifically at the impact of Promptbook on the AI industry.
+> Write an article about {topic}
 
 -> {article}
 ```
 
+Each part of the book defines one of 3 circles:
+
 ### **What:** Workflows, Tasks and Parameters
 
+What work needs to be done. Each book defines a workflow, which is one or more tasks. Each workflow has a fixed input and output. For example, you have a book that generates an article from a topic. Once it generates an article about AI, once about marketing, once about cooking. The workflow (= your AI program) is the same, only the input and output change.
+
+**Related commands:**
+
 -   [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
 
 ### **Who:** Personas
 
+Who does the work. Each task is performed by a persona. A persona is a description of your virtual employee. It is a higher abstraction than the model, tokens, temperature, top-k, top-p and other model parameters.
+
+You can describe what you want in human language like `Jane, creative writer with a sense of sharp humour` instead of `gpt-4-2024-13-31, temperature 1.2, top-k 40, STOP token ".\n",...`.
+
+Personas can have access to different knowledge, tools and actions. They can also consult their work with other personas or user, if allowed.
+
+**Related commands:**
+
 -   [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
 
+
+
 ### **How:** Knowledge, Instruments and Actions
 
--   [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md)
--   [INSTRUMENT](https://github.com/webgptorg/promptbook/blob/main/documents/commands/INSTRUMENT.md)
--   [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md)
+The resources used by the personas are used to do the work.
+
+**Related commands:**
+
+-   [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md) of documents, websites, and other resources
+-   [INSTRUMENT](https://github.com/webgptorg/promptbook/blob/main/documents/commands/INSTRUMENT.md) for real-time data like time, location, weather, stock prices, searching the internet, calculations, etc.
+-   [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md) for actions like sending emails, creating files, ending a workflow, etc.
 
 ### General principles of book language
 
@@ -284,35 +305,7 @@ The following glossary is used to clarify certain concepts:
 
 _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
-#### Promptbook core
-
--   **Organization** _(legacy name collection)_ group jobs, workforce, knowledge, instruments, and actions into one package. Entities in one organization can share resources (= import resources from each other).
-    -   **Jobs**
-        -   **Task**
-        -   **Subtask**
-    -   **Workforce**
-        -   **Persona**
-        -   **Team**
-        -   **Role**
-    -   **Knowledge**
-        -   **Public**
-        -   **Private**
-        -   **Protected**
-    -   **Instruments**
-    -   **Actions**
-
-#### Book language
-
--   **Book file**
-    -   **Section**
-        -   **Heading**
-        -   **Description**
-        -   **Command**
-        -   **Block**
-        -   **Return statement**
-    -   **Comment**
-    -   **Import**
-    -   **Scope**
+
 
 #### 💯 Core concepts
 
@@ -409,7 +402,7 @@ See [CHANGELOG.md](./CHANGELOG.md)
 
 ## 📜 License
 
-<p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="https://github.com/webgptorg/promptbook">Promptbook</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://github.com/hejny/">Pavol Hejný</a> is licensed under <a href="https://creativecommons.org/licenses/by/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC BY 4.0</a></p>
+Promptbook project is under [BUSL 1.1 is an SPDX license](https://spdx.org/licenses/BUSL-1.1.html)
 
 ## 🎯 Todos
 
@@ -417,7 +410,6 @@ See [TODO.md](./TODO.md)
 
 
 
-
 ## 🤝 Partners
 
 <div style="display: flex; align-items: center; gap: 20px;">
@@ -434,6 +426,6 @@ See [TODO.md](./TODO.md)
 
 ## 🖋️ Contributing
 
-I am open to pull requests, feedback, and suggestions. Or if you like this utility, you can [☕ buy me a coffee](https://www.buymeacoffee.com/hejny) or [donate via cryptocurrencies](https://github.com/hejny/hejny/blob/main/documents/crypto.md).
+We are open to pull requests, feedback, and suggestions.
 
-You can also ⭐ star the promptbook package, [follow me on GitHub](https://github.com/hejny) or [various other social networks](https://www.pavolhejny.com/contact/).
+You can also ⭐ star the project, [follow us on GitHub](https://github.com/hejny) or [various other social networks](https://www.pavolhejny.com/contact/).