README.md and spelling (#48)

Author: Tiendil

.donna/project/core/error_handling.md

@@ -41,7 +41,7 @@ class InternalError(core_errors.InternalError):
     pass
 
 class SomethingGoneWrong(InternalError):
-    """Indicates that something went wrong in donna.xxx submodule in a single specifc case."""
+    """Indicates that something went wrong in donna.xxx submodule in a single specific case."""
     pass
 
 class DomainOrEntityError(InternalError):
@@ -151,15 +151,15 @@ def validate_artifact(self) -> Result[None, ErrorsList]:
 
 ## Naming error classes
 
-Follow this guidelines when naming error classes:
+Follow these guidelines when naming error classes:
 
 - Try to keep names short but descriptive.
-- Prefere not to use `Error`, `Exception`, `Failure` suffixes if possible.
-- Prefere not to use `Internal` or `Environment` in the class names.
+- Prefer not to use `Error`, `Exception`, `Failure` suffixes if possible.
+- Prefer not to use `Internal` or `Environment` in the class names.
 
 ## Exceptions besides `InternalError`
 
-- **Use only `InternalError` for all Donna's internal exceptions, untill the developer or the specification explicitly requires otherwise.**
+- **Use only `InternalError` for all Donna's internal exceptions, until the developer or the specification explicitly requires otherwise.**
 - You MAY use other exception types if the third-party library you are working with requires it. For example, Pydantic models require `ValidationError` exceptions.
 - You MAY use `NotImplementedError` as temporary code when:
   - You need a temporary placeholder for the code that is not implemented yet, but will be in the scope of the current task.
@@ -185,7 +185,7 @@ Don't use `assert` statements for any other purpose, replace them with proper er
 
 ### Update all calls up the call stack
 
-If you modify funtion to return environment errors, you **MUST** update all functions up the call stack that call this function to handle the returned errors properly: process, propagate or output (accoring to the context).
+If you modify function to return environment errors, you **MUST** update all functions up the call stack that call this function to handle the returned errors properly: process, propagate or output (according to the context).
 
 ### Long error definitions — short construction
 

.donna/project/core/top_level_architecture.md

@@ -19,7 +19,7 @@ The code is separated by layers/subsystems into subpackages:
 
 - `donna.core` — code that not in the Donna's domain, but required to its functioning: domain-independent utils, basic classes for errors, exceptions and other entities, etc.
 - `donna.domain` — code that is required by all Donna'specific logic: ID classes, common types, etc.
-- `donna.machine` — code that implements the core Donna's logic — how Donna works regardles of external environments, i.e. pure domain behavior.
+- `donna.machine` — code that implements the core Donna's logic — how Donna works regardless of external environments, i.e. pure domain behavior.
 - `donna.world` — code that implements various worlds where Donna can find and manage artifacts: from artifacts discovery to their loading, parsing, updating. Also contains code related to configuration of Donna.
 - `donna.protocol` — code that implements protocol via which Donna's core domain logic interacts with external environments: CLI, API, etc. Includes basic classes for information representing (for the external environments) and its formatting.
 - `donna.cli` — code that implements the `donna` CLI tool, its commands, arguments parsing, etc.

.donna/project/intro.md

@@ -1,5 +1,5 @@
 
-# Intoduction to the Donna development
+# Introduction to the Donna development
 
 ```toml donna
 kind = "donna.lib.specification"
@@ -10,17 +10,17 @@ This document provides an introduction to the Donna project for agents and devel
 
 `Donna` is a CLI tool that helps manage the work of AI agents like Codex.
 
-It is designed to to invert control flow: instead of agents deciding what to do next, the `donna` tells agents what to do next by following predefined workflows.
+It is designed to invert control flow: instead of agents deciding what to do next, the `donna` tells agents what to do next by following predefined workflows.
 
-The core idea is that most of high-level workflows are more algorithmic than it may seem at first glance. For example, it may be difficult to fix a particular type issue in the codebase, but the overall process of polishing the codebase is quite linear:
+The core idea is that most high-level workflows are more algorithmic than it may seem at first glance. For example, it may be difficult to fix a particular type issue in the codebase, but the overall process of polishing the codebase is quite linear:
 
 1. Ensure all tests pass.
 2. Ensure the code is formatted correctly.
 3. Ensure there are no linting errors.
 4. Go to the step 1 if you changed something in the process.
 5. Finish.
 
-We may need coding agents on the each step of the process, but there no reason for agents to manage the whole grooming loop by themselves — it take longer time, spends tokens and may lead to confusion of agents.
+We may need coding agents on each step of the process, but there is no reason for agents to manage the whole grooming loop by themselves — it takes longer time, spends tokens and may lead to confusion of agents.
 
 ## Primary rules
 

.donna/project/work/polish.md

@@ -76,7 +76,7 @@ kind = "donna.lib.request_action"
 id = "run_black_script"
 kind = "donna.lib.run_script"
 save_stdout_to = "black_output"
-goto_on_success = "run_flake8_script"
+goto_on_success = "run_codespell_script"
 goto_on_failure = "fix_black"
 ```
 
@@ -101,6 +101,37 @@ kind = "donna.lib.request_action"
 2. Ensure your changes are saved.
 3. `{{ donna.lib.goto("run_autoflake_script") }}`
 
+## Run Codespell
+
+```toml donna
+id = "run_codespell_script"
+kind = "donna.lib.run_script"
+save_stdout_to = "codespell_output"
+goto_on_success = "run_flake8_script"
+goto_on_failure = "fix_codespell"
+```
+
+```bash donna script
+#!/usr/bin/env bash
+
+codespell ./donna 2>&1
+```
+
+## Fix Codespell Issues
+
+```toml donna
+id = "fix_codespell"
+kind = "donna.lib.request_action"
+```
+
+```
+{{ donna.lib.task_variable("codespell_output") }}
+```
+
+1. Fix the codespell issues based on the output above.
+2. Ensure your changes are saved.
+3. `{{ donna.lib.goto("run_autoflake_script") }}`
+
 ## Run Flake8
 
 ```toml donna

AGENTS.md

@@ -6,10 +6,10 @@ Every agent MUST follow the rules and guidelines outlined in this document when
 
 ## First actions
 
-**You need the Donna tool to work on this project.**
+**You need Donna tool to work on this project.**
 
 Since this is the repository that contains the Donna project itself, you have direct access to the Donna CLI tool via `./bin/donna.sh` script.
 
 I.e. you develop Donna using Donna.
 
-**ALWAYS** perform `./bin/donna.sh -p llm artifacts view "*:intro"` when you start working. It **MUST** be a one time operation. Do not repeat it unless you forget how to use the tool.
+**ALWAYS** run `./bin/donna.sh -p llm artifacts view '*:intro'` when you start working. It **MUST** be a one time operation. Do not repeat it unless you forget how to use the tool.