Automated docs#71
Merged
Merged
Conversation
✅ Deploy Preview for biongff-vizarr ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Collaborator
|
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 |
davehorsfall
requested changes
Apr 21, 2026
✅ Deploy Preview for biongff-vizarr ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
davehorsfall
approved these changes
Jun 29, 2026
davehorsfall
left a comment
davehorsfall
left a comment
Member
There was a problem hiding this comment.
LGTM. Thanks for making those changes.
There was a problem hiding this comment.
Pull request overview
This PR adds automated API documentation generation for the monorepo using TypeDoc (with the typedoc-github-theme plugin), along with initial viewer “Quick start” documentation and some additional inline API doc comments.
Changes:
- Add root TypeDoc configuration (
typedoc.json) and abuild:docsscript to generate docs intodocs/build. - Add initial viewer documentation (
docs/viewer/introduction.md) and reference it from a viewer-leveltypedoc.json. - Minor documentation/formatting adjustments in viewer types and props; ignore generated docs output via
.gitignore.
Reviewed changes
Copilot reviewed 8 out of 10 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
typedoc.json |
Adds monorepo TypeDoc configuration using entryPointStrategy: "packages". |
package.json |
Adds build:docs script and TypeDoc-related dev dependencies. |
pnpm-lock.yaml |
Locks new TypeDoc and theme dependencies. |
viewer/typedoc.json |
Adds viewer-specific TypeDoc config (project document reference). |
docs/viewer/introduction.md |
Adds a Quick start doc page for the viewer. |
viewer/src/state.ts |
Adds JSDoc comments to ViewState fields for generated docs. |
viewer/src/components/VizarrViewer.tsx |
Consolidates MUI imports and adds JSDoc comments to exported props/component. |
viewer/package.json |
Reformats files field to multi-line array. |
biome.json |
Updates Biome ignore list. |
.gitignore |
Ignores generated docs/build output directory. |
Files not reviewed (1)
- pnpm-lock.yaml: Generated file
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+29
to
32
| /**Level of zoom */ | ||
| zoom: number; | ||
| /** Coordinates to center the view state on */ | ||
| target: [number, number]; |
Comment on lines
+42
to
45
| /** Source image urls*/ | ||
| sources?: string[]; | ||
| /** View state of the viewer*/ | ||
| viewState?: ViewState; |
Comment on lines
+272
to
+274
| /** | ||
| *Component to render source images | ||
| */ |
|
|
||
|
|
||
| ``` | ||
| npm install @hms-dbmi/vizarr |
| }, | ||
| "files": { | ||
| "ignore": ["python", "**/package.json"] | ||
| "ignore": ["python", "**/package.json", "viewer/package.json"] |
Comment on lines
+17
to
+33
| ``` | ||
| import VizarrViewer from '@hms-dbmi/vizarr' | ||
|
|
||
| function App() { | ||
|
|
||
| const sources = ["https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.5/idr0062A/6001240_labels.zarr"] | ||
|
|
||
| return( | ||
| <VizarrViewer | ||
| sources={sources} | ||
| viewState={viewState} | ||
| /> | ||
| ) | ||
| } | ||
|
|
||
|
|
||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
cd viewer
npx typedoc --plugin typedoc-github-theme
Fixes # (issue)
Related to # (if applicable)
Type of change
Checklist
npm test)pre-commit run --all-files)