Skip to content

Automated docs #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
AlexSurtees wants to merge 5 commits into
base: dev
Choose a base branch
from
Draft

Automated docs #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5dd5692
Draft documentation for viewer
Apr 1, 2026
2b4b008
Merge branch 'dev' into automated-docs
dannda Apr 2, 2026
39ed368
Documentation config changes
May 15, 2026
e516ed8
Lint'
May 15, 2026
489e33a
Ignore formatting on package.json
May 19, 2026
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
4 changes: 3 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,6 @@ coverage/

# Temporary files
*.tmp
*.swp
*.swp

docs/build
2 changes: 1 addition & 1 deletion biome.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
}
},
"files": {
"ignore": ["python"]
"ignore": ["python", "package.json", "viewer/package.json"]
},
"vcs": {
"enabled": true,
Expand Down
33 changes: 33 additions & 0 deletions docs/viewer/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---

@davehorsfall davehorsfall Apr 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

title: Quick start
---


### Getting started

## Installation


```
npm install @hms-dbmi/vizarr
```

## Basic Usage

```
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}
/>
)
}


```
3 changes: 3 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"check": "pnpm build:viewer && pnpm -r run check",
"build:viewer": "pnpm --filter vizarr build",
"build:app": "pnpm --filter app build",
"build:docs": "pnpm typedoc --plugin typedoc-github-theme",
"build": "pnpm build:viewer && pnpm build:app",
"test": "vitest"
},
Expand All @@ -28,6 +29,8 @@
"@vitejs/plugin-react": "^4.3.4",

@davehorsfall davehorsfall Apr 21, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@davehorsfall davehorsfall Apr 21, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

"@vitest/coverage-v8": "4.0.15",
"semantic-release": "^25.0.2",
"typedoc": "^0.28.18",
"typedoc-github-theme": "^0.4.0",
"typescript": "^5.8.2",
"vite": "^6.2.7",
"vitest": "^4.0.15"
Expand Down
Loading
Loading