Update CI/CD Documentation to Accurately Reflect Workflow

[loftwah]

The current documentation incorrectly describes our CI/CD process, particularly regarding the role of CI in pushing to registries. We need to revise this documentation to accurately reflect our actual CI/CD workflow.

Tasks:

1. Review the current CI/CD documentation:

   • Identify all instances where the CI process is incorrectly described
   • Note any other outdated or inaccurate information related to our development workflow

2. Analyze the actual CI/CD workflow:

   • Review the contents of our GitHub Actions workflow files
   • Confirm the correct steps and processes of our CI/CD pipeline

3. Rewrite the CI/CD documentation:

   • Clearly describe the role of CI in our workflow
   • Accurately explain what happens during the build, test, and deployment stages
   • Clarify which processes are handled by CI and which are part of CD (if applicable)

4. Include information on:

   • What triggers our CI process
   • What tests are run and when
   • How code quality checks are performed
   • The deployment process (if part of the pipeline)

5. Add or update any relevant diagrams:

   • Create a flowchart or diagram that visually represents the correct CI/CD process
   • Ensure the diagram is clear and easy to understand for new contributors

6. Review and proofread:

   • Check for any inconsistencies or unclear explanations
   • Ensure the language is clear and accessible to both new and experienced developers

7. Update related documentation:

   • Check for any other documents that may reference the CI/CD process and update them accordingly
   • Update the README if it contains any high-level description of the CI/CD process

8. Submit for review:

   • Create a pull request with the updated documentation
   • Request review from team members familiar with the CI/CD setup

9. After approval and merging:

   • Communicate the documentation update to the team and community
   • Consider adding a note in the project's changelog about the documentation update

This task will ensure that our project documentation accurately reflects our development and deployment processes, helping new contributors understand our workflow and reducing potential confusion.

[loftwah]

If anyone wants an easy one this could be done with ChatGPT or Claude. Paste my incorrect version in with the workflows contents and it can rewrite it for us.