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 .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ Describe what this contribution adds or updates.

- [ ] I only changed files under `docs/contributions/`.
- [ ] New/updated files and folders under `docs/contributions/` use kebab-case names.
- [ ] Any docs tags I added match approved labels in `docs/tags.yml`.
- [ ] I ran `npm run build` locally and it succeeded.
- [ ] I ran `npm run typecheck` locally and it succeeded.
- [ ] I verified links and references in the changed docs pages.
- [ ] I reviewed formatting and readability.

Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/contribution-pr-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -105,5 +105,8 @@ jobs:
- name: Install dependencies
run: npm ci

- name: Typecheck site
run: npm run typecheck

- name: Build site
run: npm run build
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,3 @@ npm-debug.log*
yarn-debug.log*
yarn-error.log*
.env

*.json
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ External contributions in this repository must only modify files under `docs/con

- Only files under `docs/contributions/` can be changed.
- File and folder names inside `docs/contributions/` must be `kebab-case`.
- Tags in page front matter must match approved labels in `docs/tags.yml`.
- Pull requests must pass CI (including Docusaurus build and link checks).

## Content Template
Expand Down Expand Up @@ -58,6 +59,7 @@ Use admonitions for warnings, tips, and key details.
- Docusaurus admonitions
- Inline and block LaTeX math
- Images and `.figure` files used by this docs site
- Approved docs tags from `docs/tags.yml`

## Review Expectations

Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This repository hosts a minimal Docusaurus instance used to preview external con

- Only create or modify content inside `docs/contributions`. Changes outside this folder will be refused.
- Use kebab-case for all file and folder names to keep URLs consistent.
- Use approved docs tags from `docs/tags.yml` when adding `tags` front matter. Unknown tags fail the build.
- You may use Docusaurus admonitions and inline LaTeX math.
- You may include images and `.figure` files produced by the Aleph Plotting module in the workshop.

Expand All @@ -22,6 +23,7 @@ If you are new to Docusaurus, start with the official docs: https://docusaurus.i
- Docs pages live in `docs/contributions` and are written in Markdown or MDX.
- The first heading (`# Title`) becomes the page title. Docusaurus uses that to build navigation.
- You can add front matter at the top of a file (between `---` lines) to set metadata like `title` or `sidebar_position`.
- You can add `tags` front matter, but each tag must exactly match a key in `docs/tags.yml`.
- Use relative links for local docs pages and place images in the same folder (or a subfolder) to keep paths simple.

## How To Open A Pull Request On GitHub
Expand Down
Loading
Loading