docs: rewrite the README and associated docs

engineervix · Dec 27, 2023 · a15e624 · a15e624
1 parent b9f55c8
commit a15e624
Show file tree

Hide file tree

Showing 10 changed files with 90 additions and 195 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,14 +2,19 @@
 
 First of all, thank you for taking the time to contribute! 🎉
 
-When contributing to [this project](https://github.com/engineervix/cookiecutter-wagtail-vix), please first create an [issue](https://github.com/engineervix/cookiecutter-wagtail-vix/issues) to discuss the change you wish to make before making a change.
+When contributing to [this project](https://github.com/engineervix/cookiecutter-wagtail-vix), please first create an [issue](https://github.com/engineervix/cookiecutter-wagtail-vix/issues) to discuss the change you wish to make before sending a pull request.
+
+If you are proposing a feature:
+
+- Explain in detail how it would work.
+- Keep the scope as narrow as possible, to make it easier to implement.
+- Remember that this is a volunteer-driven project, and that contributions are welcome 😊.
 
 ## Before making a pull request
 
-1. Fork [the repository](https://github.com/engineervix/cookiecutter-wagtail-vix).
-2. Clone the repository from your GitHub.
-3. Check out a new branch and add your modification.
-4. Write tests, and ensure that they pass.
-5. Update `README.md` for your changes. Please make sure that the Table of Contents is up to date. [DocToc](https://github.com/thlorenz/doctoc) makes this pretty easy, as you simply run `doctoc README.md` (You can install it globally on your system via `npm install -g doctoc`).
-6. Commit your changes via `cz commit`, following the prompts to appropriately categorize your commit.
-7. Send a [pull request](https://github.com/engineervix/cookiecutter-wagtail-vix/pulls) 🙏
+1. Follow the instructions in the **Contributing** section of the [README.md](https://github.com/engineervix/cookiecutter-wagtail-vix#contributing)
+2. Check out a new branch and add your modification.
+3. If possible, write tests, and ensure that they pass. This project uses [unittest](https://docs.python.org/3/library/unittest.html).
+4. Update `README.md` for your changes. Please make sure that the Table of Contents is up to date. [DocToc](https://github.com/thlorenz/doctoc) makes this pretty easy, as you simply run `doctoc README.md` (You can install it globally on your system via `npm install -g doctoc`).
+5. Commit your changes. If you do it via `cz commit` or `npm run commit`, you'll get some fancy prompts to help you to appropriately categorize your commit.
+6. Send a [pull request](https://github.com/engineervix/cookiecutter-wagtail-vix/pulls) 🙏
diff --git a/README.md b/README.md
diff --git a/docs/img/aboutpage_screenshot.png b/docs/img/aboutpage_screenshot.png
diff --git a/docs/img/blogindexpage_screenshot.png b/docs/img/blogindexpage_screenshot.png
diff --git a/docs/img/contactpage_screenshot_0.png b/docs/img/contactpage_screenshot_0.png
diff --git a/docs/img/contactpage_screenshot_1.png b/docs/img/contactpage_screenshot_1.png
diff --git a/docs/img/contactpage_screenshot_2.png b/docs/img/contactpage_screenshot_2.png
diff --git a/docs/img/example_email_messages.png b/docs/img/example_email_messages.png
diff --git a/docs/img/homepage_screenshot.png b/docs/img/homepage_screenshot.png
diff --git a/docs/img/screenshot.png b/docs/img/screenshot.png