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
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,21 +46,28 @@ A short intro that explains what this page helps the reader do.

Explain one concept at a time with concrete examples.

<KotharSpark id="spk_unn2jta1kx0mnkd1" />

:::note
Use admonitions for warnings, tips, and key details.
:::

<Authors heading="Documentation Contributors" />
```

Replace the spark ID with your own, or remove the spark line if your contribution does not include external artifacts.

## Supported Content

- Markdown / MDX pages
- Docusaurus admonitions
- Inline and block LaTeX math
- Images and `.figure` files used by this docs site
- Kothar Sparks for artifacts readers should be able to view and import into their own workspace
- Approved docs tags from `docs/tags.yml`

If you want to share source files, runnable examples, generated artifacts, notebooks, datasets, or supplemental project files, prefer a Kothar Spark over pasting large artifacts directly into the page. Small code snippets that explain the text should stay directly in the page.

## Review Expectations

PRs are reviewed by the Kothar team. Clear structure, concise writing, and runnable instructions increase merge speed.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This repository hosts a minimal Docusaurus instance used to preview external con
- 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.
- You may embed Kothar Sparks for artifacts readers should be able to view and import into their own workspace.

## Docusaurus Basics

Expand All @@ -26,6 +27,22 @@ If you are new to Docusaurus, start with the official docs: https://docusaurus.i
- 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.

## Kothar Sparks

Use a Kothar Spark when you want to share artifacts that readers can easily view and import into their own workspace. Good candidates include source files, runnable examples, generated artifacts, notebooks, datasets, and supplemental project files.

Small code snippets that explain a concept should stay directly in the page. Use a spark when the artifact is something readers should open as a file, inspect as a bundle, or import into their own workspace.

Embed a spark in any Markdown or MDX contribution page with the `KotharSpark` component:

```mdx
<KotharSpark id="spk_unn2jta1kx0mnkd1" />
```

Replace the ID with the spark you want to share. The rendered card links to the hosted spark and shows its description, owner, creation date, file count, total size, and up to 10 file names.

The production build fetches spark metadata when you run `npm run build`. Invalid, private, or inaccessible spark IDs fail the build, so run the build before opening a pull request.

## How To Open A Pull Request On GitHub

1. Fork this repository to your GitHub account.
Expand Down

This file was deleted.

This file was deleted.

Loading
Loading