Skip to content

Bug fixes for API Documentation - #136

Merged
alan-wu merged 7 commits into
ABI-Software:mainfrom
akhuoa:bugfix/api-docs
Sep 24, 2026
Merged

alan-wu merged 7 commits into
ABI-Software:mainfrom
akhuoa:bugfix/api-docs

Conversation

@akhuoa

@akhuoa akhuoa commented Sep 24, 2026 •

Copy link
Copy Markdown
Member
  • The API documentation page returns a 404 when the "API Reference" button is clicked. This is due to a bug in how the markdown file is created from the component. Fixed in aab717e.
  • The other layout issues are fixed in c39c56c.

When rendering the demo apps in GitHub pages, there are some Cross-origin issues, and the libOpenCOR plugin is missing. Those are also fixed.

The updates can be tested on https://akhuoa.github.io/simulationvuer/.
The app on GitHub Pages (https://akhuoa.github.io/simulationvuer/app/#/) is now working as well.

@akhuoa
akhuoa marked this pull request as ready for review September 24, 2026 04:12
@akhuoa
akhuoa requested a lite review from Copilot September 24, 2026 04:14

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

A critical issue remains with service-worker registration for the deployed app path.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 High severity

Open (1)
What changed in this PR

Fixes API documentation generation and supports libOpenCOR demos with GitHub Pages cross-origin isolation.

Changes:

  • Handles missing component type metadata.
  • Adds reusable libOpenCOR Vite integration.
  • Adds service-worker isolation and layout fixes.
File Reviewed changes
vuese-generator.js Handles incomplete type metadata.
vite.config.js Uses the shared libOpenCOR plugin.
vite-plugin-libopencor.js Serves and copies libOpenCOR assets.
docs/​public/​coi-serviceworker.js Adds cross-origin isolation support.
docs/​.vitepress/​config.js Configures docs build and service-worker registration.
docs/​.vitepress/​theme/​custom.css Applies consistent box sizing.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/.vitepress/config.js Resolved
@akhuoa
akhuoa requested a review from alan-wu September 24, 2026 04:50

@alan-wu alan-wu left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks, it looks good to me. This seems to be the way to add the headers into the github pages.

@alan-wu
alan-wu merged commit d632a3c into ABI-Software:main Sep 24, 2026
4 checks passed
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.

3 participants