Skip to content

Automated docs#71

Draft
AlexSurtees wants to merge 2 commits intodevfrom
automated-docs
Draft

Automated docs#71
AlexSurtees wants to merge 2 commits intodevfrom
automated-docs

Conversation

@AlexSurtees
Copy link
Copy Markdown
Collaborator

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
Copy link
Copy Markdown

netlify bot commented Apr 1, 2026

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...

QR Code

Use your smartphone camera to open QR code link.

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

@AlexSurtees AlexSurtees changed the base branch from main to dev April 1, 2026 09:13
@dannda
Copy link
Copy Markdown
Collaborator

dannda commented Apr 2, 2026

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants