Automated docs

[AlexSurtees]

Description

cd viewer
npx typedoc --plugin typedoc-github-theme

Fixes # (issue)
Related to # (if applicable)

Type of change

• 🐛 Bug fix (non-breaking change that resolves an issue)
• ✨ New feature (non-breaking change that adds functionality)
• ⚡ Optimisation (non-breaking improvement to performance or efficiency)
• [x ] 🧩 Documentation (adds or improves documentation)
• 🧱 Maintenance (refactor, dependency update, CI/CD, etc.)
• 🔥 Breaking change (fix or feature that causes existing functionality to change)

Checklist

• All tests pass (eg. npm test)
• Pre-commit hooks run successfully (eg. pre-commit run --all-files)
• Documentation updated (if required)

[netlify]

✅ Deploy Preview for biongff-vizarr ready!

Name	Link
🔨 Latest commit	2b4b008
🔍 Latest deploy log	https://app.netlify.com/projects/biongff-vizarr/deploys/69ce30b38ea8de0009e946c2
😎 Deploy Preview	https://deploy-preview-71--biongff-vizarr.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[dannda]

can I suggest having a typedoc.json at root level like

{
  "entryPointStrategy": "packages",
  "entryPoints": ["./*"], // or ["viewer"]
  "packageOptions": {
    "entryPoints": ["src/index.tsx"]
  }
}

and the typedoc.json in viewer like

{
  "projectDocuments": ["introduction.md"]
}

so that we can have a command in the root package json to build the docs
"build:docs": "pnpm typedoc --plugin typedoc-github-theme"
for all the packages (viewer and plugins) together

[davehorsfall]

Could we add a docs:build script to package.js to standard how the docs are built?

[davehorsfall]

Also, could you add instructions to the contributing guide about how to build and check the automated docs after changes are made?

[davehorsfall]

I think we can expect there to be several static content pages for the documentation website. Instead of putting these in the viewer root (which might get cluttered), could we perhaps move these into docs, and move the build directory to docs/build, which can be excluded in .gitignore?

[netlify]

✅ Deploy Preview for biongff-vizarr ready!

Name	Link
🔨 Latest commit	489e33a
🔍 Latest deploy log	https://app.netlify.com/projects/biongff-vizarr/deploys/6a0c5415a2c43d00087f6271
😎 Deploy Preview	https://deploy-preview-71--biongff-vizarr.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!