docs: documentation improvements based on feedback

ReadAlongs · Jul 15, 2024 · 823a2b7 · 823a2b7
1 parent 96c6a67
commit 823a2b7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/docs/outputs.md b/docs/outputs.md
@@ -5,11 +5,11 @@ With that in mind, there are a variety of different output formats that can be c
 
 ## Simple web deployment
 
-The `www` folder generated by the CLI's `readalongs align` command or included in the Web Bundle download format from the [Web App](web-app.md) include everything you need to host your ReadAlong on your own server.
+The `www` folder generated by the CLI's `readalongs align` command or included in the Web Bundle download format from the [Web App](web-app.md) includes everything you need to host your ReadAlong on your own server.
 
 Copy the whole folder with all its contents to your web server, and that should work as is on most web servers. The `index.html` provided will generate a page that shows only your readalong.
 
-The elements of the `index.html` can also be copied into a larger page with other contents, or multiple readalongs -- see [Web Component details](#web-component-details) below.
+The elements of the `index.html` can also be copied into a larger page with other contents or multiple readalongs -- see [Web Component details](#web-component-details) below.
 
 ## WordPress deployment
 
@@ -51,10 +51,11 @@ www
 ├── assets
 │   ├── sample.wav
 │   └── sample.readalong
-└── index.html
+├── index.html
+└── readme.txt
 ```
 
-Then you can host your site anywhere, or run it locally (`cd web && python3 -m http.server` for example)
+Then you can host your site anywhere, or run it locally (`cd www && python3 -m http.server` for example)
 
 ## Single-file HTML
 

diff --git a/test/test_align_cli.py b/test/test_align_cli.py
@@ -188,7 +188,7 @@ def test_align_with_package(self):
         self.assertEqual(results_html.exit_code, 0)
         self.assertTrue(
             exists(join(output, "Offline-HTML", "html.html")),
-            "succesful html alignment should have created html/Offline-HTML/html.html",
+            "successful html alignment should have created html/Offline-HTML/html.html",
         )
 
         with open(join(output, "Offline-HTML", "html.html"), "rb") as fhtml: