-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
This issue outlines a pre-flight checklist to ensure that all aspects of a new course are correctly integrated and render as expected on the website before launch.
A quick outline of a potential checklist could be:
# Checklist
- **Content Rendering:**
- [ ] Verify that all notebooks, interactive plots, and static content (e.g., slides, PDFs) render properly within the Jupyter Book and website environment.
- **Metadata Accuracy:**
- [ ] Confirm that course metadata is correctly split between `programme_information` and `section_landing_page`.
- [ ] Ensure that each page displays the intended content without overlap or confusion.
- **Asset Linking:**
- [ ] Validate that all file paths (including those containing spaces or special characters, URL encoded as necessary) are accessible and display correctly.
- **Interactive Elements:**
- [ ] Confirm that interactive elements (e.g., figures, embedded HTML files) function correctly and maintain interactivity on the website.
- **Where is my understanding quiz?**
- [ ] Confirm that the 'Where is my understanding?' quiz has been created for the course?
## Additional Notes
- If any issues arise from this checklist, please document them in separate issues for tracking and resolution.
- This checklist is a living document and may be updated as our review process evolves.
- Please provide feedback or suggest any additional items that should be included in the checklist.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation