Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Jupyter ephemera
.ipynb_checkpoints

# pixi environments
.pixi
Expand Down
14 changes: 13 additions & 1 deletion for-instructors/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,20 @@ Diátaxis is a fantastic resource for writing documentation for various audience
Goal: Provide in-depth understanding of a concept, often linking multiple concepts
together or explaining a technical decision, architecture, or history.

## Repository structure

## Structure
### Notebooks vs. Markdown

Notebooks and Markdown can be used interchangeably.
This means the content for your module can be stored in `index.md` or `index.ipynb`.

Supporting Notebooks can be stored as neighbors to your index file, and your Notebooks
can link to each other.
When participants open the Notebooks in JupyterLab they can click the links to
automatically open other Notebooks.


## Content structure

All modules should have a consistent structure!

Expand Down
2 changes: 1 addition & 1 deletion myst.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ project:
- pattern: "0*.md"
- title: "Modules"
children:
- pattern: "modules/0*/index.md"
- pattern: "modules/0*/index.{md,ipynb}"
- title: "Reference"
children:
- pattern: "reference/*.md"
Expand Down