chore: Linting

Signed-off-by: Eatham532 <78714349+Eatham532@users.noreply.github.com>

Author: Eatham532

CONTRIBUTING.md

@@ -25,6 +25,7 @@ Before contributing, ensure you have:
 - Python 3.13+ (or any Python 3.x version)
 
 - [uv](https://docs.astral.sh/uv/) for Python package management
+
 - [uv](https://docs.astral.sh/uv/) (recommended) or `pip` for Python package management
 
 - Git for version control
@@ -52,6 +53,7 @@ Before contributing, ensure you have:
    # Or use pip (standard Python installer)
    python -m pip install --upgrade pip
    python -m pip install -e .
+
    ```
 
 3. **Activate the virtual environment**:

README.md

@@ -13,23 +13,33 @@ This is a **comprehensive digital textbook** aligned with the **NSW HSC Software
 The project is currently about **90% generated by AI**, with ongoing **human editing** for accuracy, context, and clarity. As a free and **open-source resource**, it is a work in progress and will continually evolve with community contributions.
 
 **Key features include:**
+
 * **Interactive Quizzes** for immediate self-assessment.
+
 * Extensive **Python Code Samples** and real-world case studies.
+
 * **Diagrams and Visualizations** for complex concepts.
 
 ## 📚 Syllabus Content
 
 The content is organized directly according to the NESA syllabus modules.
 
 ### Year 11 Modules
+
 * **Programming Fundamentals**: Software development life cycles, algorithms, data structures, and Python programming.
+
 * **Object-Oriented Paradigm**: Core OOP concepts, design patterns, and practical implementation in Python.
+
 * **Programming Mechatronics**: Integrating hardware and software, and an introduction to embedded systems.
 
 ### Year 12 Modules
+
 * **Programming for the Web**: Full-stack web development, database integration, and an introduction to Progressive Web Apps (PWAs).
+
 * **Secure Software Architecture**: Foundational security principles, cryptography, and best practices for secure coding.
+
 * **Software Automation**: Machine Learning, Artificial Intelligence, ethical considerations, and impact assessment of automation.
+
 * **Software Engineering Project**: **Project management methodologies, planning, documentation, and the complete system development life cycle.**
 
 ## ✨ Key Features
@@ -47,8 +57,11 @@ The content is organized directly according to the NESA syllabus modules.
 We welcome contributions from **educators, students, and developers** to help refine and expand this vital resource!
 
 **We Need Your Help With:**
+
 * **Content Review**: Verifying accuracy, adding more in-depth examples, and creating new exercises.
+
 * **Technical Enhancements**: Improving site features, accessibility, and performance optimization.
+
 * **Community Support**: Reporting bugs, providing feedback, and spreading the word.
 
 To get started, please read our comprehensive **[Contributing Guide](CONTRIBUTING.md)** for detailed instructions on setup, content standards, and workflow.
@@ -60,7 +73,9 @@ This project is open source and available under the **[MIT License](LICENSE)**.
 We extend our sincere thanks to the following:
 
 * **NSW Education Standards Authority (NESA)** for providing the comprehensive Software Engineering syllabus.
+
 * **The open-source community** for excellent tools and libraries, especially **MkDocs** and **Material for MkDocs**.
+
 * **All contributors and educators** who provide ongoing feedback and improvements.
 
 ## Share This Resource!

docs/Year12/SoftwareEngineeringProject/Chapter-26-Testing-and-evaluating/26-01-Testing-methodologies-and-optimisation/index.md

@@ -845,8 +845,11 @@ Components of effective test cases:
 **Acceptance Test Criteria**:
 
 - Directly tied to user stories and requirements
+
 - Written in business language, not technical terms
+
 - Testable and measurable outcomes
+
 - Clear pass/fail criteria
 
 ///
@@ -1076,25 +1079,37 @@ Both automated and manual testing serve important roles in a comprehensive testi
 **Automated Testing - Best For**:
 
 - **Regression testing**: Re-running tests after code changes
+
 - **Performance testing**: Load and stress testing scenarios
+
 - **Repetitive tests**: Tests that need frequent execution
+
 - **Data-driven testing**: Testing with large datasets
+
 - **Continuous integration**: Tests that run with every build
 
 **Manual Testing - Best For**:
 
 - **Exploratory testing**: Discovering unexpected issues
+
 - **Usability testing**: Evaluating user experience
+
 - **Ad-hoc testing**: Unstructured investigation
+
 - **Initial test creation**: Developing new test scenarios
+
 - **Complex scenarios**: Tests requiring human judgment
 
 **Decision Factors**:
 
 - Test frequency and repetition requirements
+
 - Complexity of test scenarios
+
 - Available resources and timeline
+
 - Return on investment for automation
+
 - Type of functionality being tested
 ///
 

docs/code-editor/index.md

@@ -1,8 +1,11 @@
 ---
 title: Python Code Editor
 hide:
+
   - navigation
+
   - toc
+
   - footer
 template: main.html
 ---