Initial Commit

Author: liamjberrisford

LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) YEAR Your
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,128 @@
+
+# Research Coding Community (RCC) Website Template
+
+Welcome! This repository is a **template** for launching your own Research Coding Community website using **Jupyter Book**. It includes:
+
+- 📚 A ready-to-edit site structure (home, community pages, courses)
+- ✅ Working **GitHub Actions** for CI/CD to **deploy to GitHub Pages**
+- 🧩 **Interactive quizzes** via `jupyterquiz` with sample content
+- 🧪 Optional **accessibility checks** workflow (Pa11y)
+- 🧰 Examples & placeholders only — **no real content**
+
+---
+
+## Quick Start (the 5-minute version)
+
+1. **Create your repo from this template**  
+   - On GitHub, click **Use this template** → **Create a new repository**.  
+   - Or fork this repo.
+
+2. **Enable GitHub Pages**  
+   - Go to **Settings → Pages**.  
+   - Set **Source** to **GitHub Actions**.
+
+3. **Edit site config**  
+   - Open `_config.yml` and replace the placeholders for `title`, `author`, `repository.url`, and the `logo` path if you change it.
+
+4. **Add or edit content**  
+   - Update `home_page.md`.  
+   - Edit community pages in `community/`.  
+   - Add/modify courses in `courses/`, update `_toc.yml` accordingly.  
+   - Try the quiz in `courses/example_course/example_lesson.ipynb`.
+
+5. **Push to `main`**  
+   - GitHub Actions will build and deploy your site automatically.  
+   - Your site will be available at: `https://<your-username>.github.io/<your-repo>/`
+
+---
+
+## Repository Structure
+
+```
+.
+├─ _config.yml                 # Jupyter Book site config (title, logo, repo, etc.)
+├─ _toc.yml                    # Table of contents (navigation)
+├─ home_page.md                # Landing page
+├─ community/                  # Community pages (About, Code of Conduct, Join)
+├─ courses/
+│  └─ example_course/
+│     ├─ README.md            # Course overview
+│     └─ example_lesson.ipynb # Example notebook with quiz
+├─ quizzes/
+│  └─ sample_quiz.json        # Example quiz
+├─ _static/
+│  └─ logo.png                # Placeholder logo (replace with your own)
+├─ .github/workflows/
+│  ├─ build-book.yml          # Build on PRs to check that site compiles
+│  ├─ deploy-book.yml         # Build & deploy to GitHub Pages on push to main
+│  └─ accessibility.yml       # Optional: Pa11y accessibility checks
+├─ requirements.in            # Python dependencies (pip)
+├─ pyproject.toml             # Optional Poetry project
+└─ .gitignore
+```
+
+---
+
+## Customising the Site
+
+- **Branding:** Replace `_static/logo.png` and set the `logo:` path in `_config.yml`.
+- **Theme:** Jupyter Book uses Sphinx Book Theme. You can add custom CSS in `_static/` and reference it in `_config.yml`.
+- **Content:** Add new courses in `courses/your_course/` and include them in `_toc.yml`.
+
+---
+
+## Interactive Quizzes (JupyterQuiz)
+
+1. Put quiz JSON files in `quizzes/`. See `quizzes/sample_quiz.json`.
+2. In a notebook, add:
+
+   ```python
+   from jupyterquiz import display_quiz
+   display_quiz("quizzes/sample_quiz.json")
+   ```
+
+3. When the site builds, quizzes render as interactive widgets in the page.
+
+---
+
+## Local Preview (optional)
+
+```bash
+# Using pip
+pip install -r requirements.in
+jupyter-book build .
+# Open _build/html/index.html in your browser
+
+# Or with Poetry
+poetry install
+poetry run jupyter-book build .
+```
+
+---
+
+## Deployment: GitHub Actions → GitHub Pages
+
+- Pushing to `main` triggers the **Deploy** workflow.  
+- The workflow builds the Jupyter Book and publishes it to **GitHub Pages**.  
+- Check **Actions** for logs if something fails.
+
+> Tip: You can also run the **Build** workflow on pull requests as a smoke test.
+
+---
+
+## Accessibility (optional, recommended)
+
+The `accessibility.yml` workflow runs [Pa11y](https://pa11y.org/) to flag potential accessibility issues. You can disable it by removing the workflow or keep it to improve inclusivity.
+
+---
+
+## Contributing / Community
+
+- Update `community/about.md` and `community/join.md` for your group.
+- Consider adding a `CONTRIBUTING.md` and updating the Code of Conduct in `community/code_of_conduct.md`.
+
+---
+
+## License
+
+This template is provided under the **MIT License**. Replace the license if you need a different one for your community.

_build/.doctrees/community/about.doctree

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: ce2181896316a911aa65ba2e0178eaf7
+tags: 645f666f9bcd5a90fca523b33c5a78b7