Skip to content

docs(website): fix website examples#3395

Merged
jourdain merged 1 commit intoKitware:masterfrom
daker:fix-vitepress
Feb 2, 2026
Merged

docs(website): fix website examples#3395
jourdain merged 1 commit intoKitware:masterfrom
daker:fix-vitepress

Conversation

@daker
Copy link
Collaborator

@daker daker commented Feb 2, 2026

Context

Results

Changes

  • Documentation and TypeScript definitions were updated to match those changes

PR and Code Checklist

  • semantic-release commit messages
  • Run npm run reformat to have correctly formatted code

Testing

  • This change adds or fixes unit tests
  • Tested environment:
    • vtk.js:
    • OS:
    • Browser:

@daker
Copy link
Collaborator Author

daker commented Feb 2, 2026

@jourdain Could you check this? I moved some files around to make VitePress work as expected. The examples build time should drop from ~10 min to ~25 secs.

@@ -11,4 +11,4 @@ If you are looking for general information on VTK pipelines, data structures, an
[![VTK Book][Book]](https://www.vtk.org/vtk-textbook/)
[Download the book in PDF for free](https://www.vtk.org/vtk-textbook/)

[Book]: ./books_VTK_textbook.png
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are you sure? That was working in the current deployed version

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

yes i moved the static files under public

@@ -160,4 +160,4 @@ representations, check out the above `SVGHelpers.js`, which requires `snabbdom`
to be installed. An example usage can be found in the `vtkPolyLineWidget`
example.

[WidgetsDiagram]: ./gallery/widgets_diagram.png
Copy link
Collaborator

Choose a reason for hiding this comment

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

I guess you validated that links path should be absolute

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

That’s what the documentation says when a base URL is used.

https://vitepress.dev/guide/asset-handling#base-url

@jourdain jourdain enabled auto-merge February 2, 2026 22:53
@jourdain
Copy link
Collaborator

jourdain commented Feb 2, 2026

We just need to wait on the CI and see if that fix the current set of issues. Otherwise, the changes you've made make sense.

@jourdain
Copy link
Collaborator

jourdain commented Feb 2, 2026

You need to fix the ci workflow that still do a check on doc:generate-api instead of docs:generate-api

auto-merge was automatically disabled February 2, 2026 23:04

Head branch was pushed to by a user without write access

@jourdain
Copy link
Collaborator

jourdain commented Feb 2, 2026

I think you need to fix the ci yaml as they are still pointing to old npm target. (doc: vs docs)

@daker
Copy link
Collaborator Author

daker commented Feb 2, 2026

i think it should be good now

@jourdain jourdain merged commit 4a56581 into Kitware:master Feb 2, 2026
2 checks passed
@jourdain
Copy link
Collaborator

jourdain commented Feb 2, 2026

Just forced merge after the basic check went through... Now we should monitor https://github.com/Kitware/vtk-js/actions/runs/21609596305

@daker daker deleted the fix-vitepress branch February 2, 2026 23:12
@jourdain
Copy link
Collaborator

jourdain commented Feb 2, 2026

Looks great, thanks!

I think we can gradually improve things from now. Thanks again for doing that migration.

@daker
Copy link
Collaborator Author

daker commented Feb 2, 2026

@jourdain The full build now takes 3 minutes, and it’s starting to look much better.

@jourdain
Copy link
Collaborator

jourdain commented Feb 2, 2026

Indeed, do you know how we can for few examples build them as standalone html (no side files)?

The reason why I'm asking is that we need those standalone "apps" like in the case of trame-vtk and more specifically this issue which is linked to that line.

@daker
Copy link
Collaborator Author

daker commented Feb 2, 2026

@jourdain Could you take a look at #3396? I’ll check the standalone build tomorrow

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