docs: summarize bottom half of doc

Author: lpm0073

README.md

@@ -79,63 +79,23 @@ A REST API implementing each of the [30 example applications](https://platform.o
 
 Detailed documentation for each endpoint is available here: [Documentation](./doc/examples/)
 
-## Examples of Code Management Best Practices
-
-This repo is referenced by multiple YouTube videos, including various tutorials about good coding practices and good code management. Of note:
-
-### Automations
-
-- [Automated Pull Requests](https://github.com/FullStackWithLawrence/aws-openai/pulls?q=is%3Apr+is%3Aclosed): Github Actions are triggered on pull requests to run any of several different kinds of technology-specific unit tests depending on the contents of the commits included in the PR.
-- [python-dotenv](https://pypi.org/project/python-dotenv/) for storing sensitive data for local development
-- [.gitignore](./.gitignore) ensures that no sensitive nor useless data accidentally gets pushed to GitHub.
-- [tox.ini](./tox.ini) file for configuring behaviors of Python testing tools
-- [GitHub Actions](https://github.com/features/actions) automates unit testing, semantic release rule checking, and dependabot actions.
-- [GitHub Secrets](https://github.com/FullStackWithLawrence/aws-openai/settings/secrets/actions) to provide sensitive data to Github Actions workflows
-- [GitHub Issues](https://github.com/features/issues)
-- [Makefile](./Makefile) automates procedures like init, build, test, release and linting for Python, ReactJS and Terraform.
-- [pre-commit](https://pre-commit.com/) automatically enforces a multitude of code quality, coding style and security policies.
-- [Dependabot](https://github.com/dependabot) automatically updates the version pins of code library dependencies for Python, ReactJS and Terraform.
-- [Unit Tests](https://docs.pytest.org/) are automated and can be invoked
-  - manually from the command line
-  - manually from GitHub Actions
-  - automatically by Dependabot.
-- [Mergify](https://mergify.com/) automates processing of bot-created pull requests
-- [Semantic Release](https://github.com/semantic-release/semantic-release) automates version releases as well as maintains the change log for the repo.
-- [Change Log](http://keepachangelog.com/)
-
-### Linters and Formatters
-
-Linters and formatters are tools used in programming to analyze and improve the quality of code. This project leverages several, including:
-
-#### Code Formatting
-
-- [Prettier](https://prettier.io/): an opinionated code formatter that supports many file formats and languages. This project leverages Prettier to standardize formatting of md, css, json, yml, js, jsx and Typescript files.
-- [Black](https://github.com/psf/black): an opinionated code formatter for Python which is compatible with [PEP 8](https://peps.python.org/pep-0008/) and the [Python Style Guide](https://www.python.org/doc/essays/styleguide/).
-- [isort](https://pycqa.github.io/isort/): a Python utility that sorts imports alphabetically, and automatically, separated into sections and by type.
-
-#### Code Analysis
-
-- [ESLint](https://eslint.org/): an open source project that helps you find and fix problems with your JavaScript and JSX code.
-- [Flake8](https://flake8.pycqa.org/en/latest/): provides Python syntax checking, naming style enforcement, code style enforcement, and [cyclomatic complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) analysis.
-- [pylint](https://pypi.org/project/pylint/): a static code analyser for Python. It analyses your code without actually running it. It checks for errors, enforces a coding standard, looks for code smells, and can make suggestions about how the code could be refactored.
-- [bandit](https://github.com/PyCQA/bandit): a tool designed to find common security issues in Python code.
+## Support
 
-#### Pre-commit hooks
+To get community support, go to the official [Issues Page](https://github.com/FullStackWithLawrence/aws-rekognition/issues) for this project.
 
-- [pre-commit Hooks](https://pre-commit.com/hooks.html): scripts that run automatically before each commit is made to a repository, checking your code for embedded passwords, errors, issues, and any of a multitude of configurable policies that you can optionally enforce. They're part of the git hooks system, which allows you to trigger actions at certain points in git's execution. This project uses many Hooks. See [pre-commit-config.yaml](https://github.com/FullStackWithLawrence/aws-openai/blob/main/.pre-commit-config.yaml#L45).
-- [codespell](https://github.com/codespell-project/codespell): fixes common misspellings in text files. It's designed primarily for checking misspelled words in source code, but it can be used with other files as well.
+## Good Coding Best Practices
 
-## Support
+This project demonstrates a wide variety of good coding best practices for managing mission-critical cloud-based micro services in a team environment, namely its adherence to [12-Factor Methodology](./doc/Twelve_Factor_Methodology.md). Please see this [Code Management Best Practices](./doc/GOOD_CODING_PRACTICE.md) for additional details.
 
-To get community support, go to the official [Issues Page](https://github.com/FullStackWithLawrence/aws-openai/issues) for this project.
+We want to make this project more accessible to students and learners as an instructional tool while not adding undue code review workloads to anyone with merge authority for the project. To this end we've also added several pre-commit code linting and code style enforcement tools, as well as automated procedures for version maintenance of package dependencies, pull request evaluations, and semantic releases.
 
 ## Contributing
 
 We welcome contributions! There are a variety of ways for you to get involved, regardless of your background. In addition to Pull requests, this project would benefit from contributors focused on documentation and how-to video content creation, testing, community engagement, and stewards to help us to ensure that we comply with evolving standards for the ethical use of AI.
 
 For developers, please see:
 
-- the [Developer Setup Guide](./CONTRIBUTING.md)
-- and these [commit comment guidelines](./SEMANTIC_VERSIONING.md) 😬😬😬 for managing CI rules for automated semantic versioning.
+- the [Developer Setup Guide](./doc/CONTRIBUTING.md)
+- and these [commit comment guidelines](./doc/SEMANTIC_VERSIONING.md) 😬😬😬 for managing CI rules for automated semantic releases.
 
 You can also contact [Lawrence McDaniel](https://lawrencemcdaniel.com/contact) directly.