Merge pull request #84 from UBC-MDS/update_code_of_conduct

Update code of conduct

Author: EricYangg

CODE_OF_CONDUCT.md

@@ -62,7 +62,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-\[INSERT CONTACT METHOD\].
+https://github.com/UBC-MDS/Sudoku_Validation/issues.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

README.md

@@ -41,13 +41,6 @@ There are other Python packages that provide similar functionality. Here are som
 
 > Note: this package is a work in progress and might contain example code that is not used in the final product. 
 
-## Contributors
-
-Justin Mak: justinmak08@gmail.com
-Eric Yang: eric99yang@gmail.com
-Kin Chung Choy: kcchoyaa@connect.ust.hk
-Omowunmi Obadero: obaderoomowunmi@gmail.com
-
 ## Get started
 
 You can install this package into your preferred Python environment using pip:
@@ -76,6 +69,89 @@ sudoku_board = [
 sudoku_validation.combined_validation(sudoku_board)
 ```
 
+## 📚 Documentation
+
+The full documentation for this package is built using **Quarto** and **Quartodoc** and
+is automatically deployed to **GitHub Pages** via GitHub Actions.
+
+Live documentation:
+[https://ubc-mds.github.io/Sudoku_Validation/](https://ubc-mds.github.io/Sudoku_Validation/)
+
+The documentation includes:
+- A full API reference generated with Quartodoc
+- Usage examples for all validation functions
+- Developer instructions for building and previewing documentation
+
+
+
+## 👥 For Developers
+
+This section provides instructions for contributors and developers working on
+the Sudoku Validation package.
+
+### Setting Up the Development Environment
+
+#### 1. Clone the repository
+
+```bash
+git clone https://github.com/UBC-MDS/Sudoku_Validation.git
+cd sudoku_validation
+```
+
+#### 2. Create an Environment Using Conda
+
+```bash
+conda env create -f environment.yml
+conda activate sudoku-validation
+```
+
+#### 3. Install the package in Development Mode
+
+```bash
+pip install -e ".[dev]"
+```
+
+#### Running Tests
+
+Execute the full test suite:
+```bash
+pytest 
+``` 
+
+#### Building Documentation
+
+Build documentation locally:
+```bash
+cd docs
+quarto render
+```
+To preview documentation in a browser:
+```bash
+quarto preview
+```
+
+## Continuous Integration and Deployment
+
+All tests, formatting checks and documentation builds are automatically built and deployed using GitHub Actions.
+On every push to the main branch, Quarto renders the documentation and publishes
+it to GitHub Pages.
+No manual deployment steps are required.
+
+
+## Contributing
+
+Please check contributing for guidelines on:
+Reporting bugs
+Suggesting features
+Submitting pull requests
+
+## Contributors
+
+Justin Mak: justinmak08@gmail.com
+Eric Yang: eric99yang@gmail.com
+Kin Chung Choy: kcchoyaa@connect.ust.hk
+Omowunmi Obadero: obaderoomowunmi@gmail.com
+
 ## Copyright
 
 - Copyright © 2026 Justin Mak, Eric Yang, Kin Chung Choy, Omowunmi Obadero.

environment.yml

@@ -0,0 +1,15 @@
+name: sudoku_validation
+
+channels:
+  - conda-forge
+
+dependencies:
+  - python=3.12
+  - numpy
+  - pandas
+  - pytest
+  - quarto
+  - pip
+
+  - pip:
+      - quartodoc