|
| 1 | +# Agent Guide: awesome-nutrient |
| 2 | + |
| 3 | +Curated collection of Nutrient examples, demos, and resources. |
| 4 | +This is **not** an SDK repository. |
| 5 | + |
| 6 | +## Start Here |
| 7 | + |
| 8 | +Before making changes, inspect these files instead of relying on this guide as a second source of truth: |
| 9 | + |
| 10 | +- `README.md` — top-level catalog, content taxonomy, and main entry points |
| 11 | +- `playground/README.md` — Playground-specific organization and navigation |
| 12 | +- The nearest category `README.md` under `web/` (or another platform folder) — local conventions and example index |
| 13 | +- The example's own `README.md` and `package.json` — setup and run instructions |
| 14 | +- `package.json` — repo-level scripts |
| 15 | +- `biome.json` — formatting and linting rules |
| 16 | +- `.github/workflows/` — CI checks |
| 17 | +- `DISCLAIMER.md` — support expectations for this repo |
| 18 | + |
| 19 | +Do not duplicate the contents of those files here. |
| 20 | + |
| 21 | +## Contribution Types |
| 22 | + |
| 23 | +Choose the right kind of contribution for the content you are adding: |
| 24 | + |
| 25 | +| Type | Use When | Primary Location | |
| 26 | +|------|----------|------------------| |
| 27 | +| **Playground snippet** | Small, browser-based examples that should run instantly with no local setup | `playground/` | |
| 28 | +| **Runnable local example** | Multi-file examples intended to be installed and run locally | Platform/category folders such as `web/` | |
| 29 | +| **External link / catalog entry** | The canonical implementation or documentation lives in another repo or on nutrient.io | Relevant README/index file | |
| 30 | + |
| 31 | +If unsure, prefer linking to the canonical source over creating a duplicate copy here. |
| 32 | + |
| 33 | +## Playground Snippets |
| 34 | + |
| 35 | +For Playground work: |
| 36 | + |
| 37 | +- Start in `playground/README.md` |
| 38 | +- Follow the existing category structure under `playground/` |
| 39 | +- Update the relevant `playground/web-*.md` index file so the snippet remains discoverable |
| 40 | +- Use `playground/package.json` and `playground/tsconfig.json` as the source of truth for validation |
| 41 | + |
| 42 | +## Runnable Local Examples |
| 43 | + |
| 44 | +For local examples: |
| 45 | + |
| 46 | +- Follow the conventions already used in the folder you are editing |
| 47 | +- Add or update the example's own `README.md` with a short description and quick start |
| 48 | +- Update the nearest category `README.md` so the example is discoverable |
| 49 | +- If needed, update the root `README.md` when adding a new top-level category or notable entry point |
| 50 | +- Do **not** assume every example uses the same run script — inspect that example's `package.json` |
| 51 | + |
| 52 | +## Contribution Rules |
| 53 | + |
| 54 | +- Keep changes focused and easy to discover |
| 55 | +- Update the relevant README/index whenever you add, remove, move, or rename content |
| 56 | +- Prefer canonical links over duplicated code when appropriate |
| 57 | +- Preserve naming and folder conventions used in the area you are editing |
| 58 | +- Use `@nutrient-sdk/viewer` for new Web SDK examples instead of legacy `pspdfkit` |
| 59 | +- Do not add guidance or claims that conflict with `DISCLAIMER.md` |
| 60 | + |
| 61 | +## Validation |
| 62 | + |
| 63 | +Before opening a PR: |
| 64 | + |
| 65 | +- Run the relevant repo-level or example-level scripts from `package.json` |
| 66 | +- Verify changed links and referenced paths |
| 67 | +- Check `.github/workflows/` if CI expectations are unclear |
| 68 | +- Run formatting via the repo's documented scripts when applicable |
0 commit comments