Repository navigation
feat: embed @gemara/react live demo in the website - #52
PaarthPandey10 wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
🤖 (summary)
Thanks for putting this together. The description and the diff don't line up: the Makefile, workflow, .gitignore, and nav changes it lists aren't here, and it removes an unrelated sentence from index.md. Were you able to build and run this locally?
| compliance activities, their interactions, and schemas for automated interoperability. | ||
|
|
||
| url: "https://gemara.openssf.org" | ||
| url: "[https://gemara.openssf.org](https://gemara.openssf.org)" |
There was a problem hiding this comment.
🤖 (high)
These URLs got wrapped in markdown link syntax (here and in social_links), which is what's breaking the Jekyll build.
| <div class="demo-iframe-container" style="margin: 1.5rem 0; border: 2px solid var(--color-border); border-radius: var(--radius-md); overflow: hidden; background: var(--color-bg-secondary); box-shadow: var(--shadow-sm);"> | ||
| <iframe | ||
| id="gemara-demo-frame" | ||
| src="{{ '/assets/demo/frame.html' | relative_url }}" |
There was a problem hiding this comment.
🤖 (high)
Nothing in the deploy pipeline builds /assets/demo/frame.html. deploy.yml has no Node setup or npm ci, so this would 404 on the live site.
|
🤖 (summary) Bigger picture, I'd rather not add a Node toolchain to this Jekyll and Go pipeline. Would hosting the demo in gemaraproj/gemara-react and embedding it here work for you? |
Switching to comments so you can iterate. Feedback inline still stands.
|
Hi @jmeridth, thanks again for the guidance on this! I've updated the PR based on your feedback:
All CI build and validation checks are now completely green. Let me know if this implementation looks good to you! |
jmeridth
left a comment
There was a problem hiding this comment.
🤖 (summary)
Thanks for moving this to gemara-react. The PR description still describes the earlier Node build in tools/demo. Could you update it to match the iframe approach?
| <div class="demo-iframe-container" style="margin: 1.5rem 0; border: 2px solid var(--color-border); border-radius: var(--radius-md); overflow: hidden; background: var(--color-bg-secondary); box-shadow: var(--shadow-sm);"> | ||
| <iframe | ||
| id="gemara-demo-frame" | ||
| src="https://gemaraproj.github.io/gemara-react/" |
There was a problem hiding this comment.
🤖 (high)
This URL returns 404 right now, and Pages isn't enabled on gemara-react yet. Merging this would add nav, sidebar, and homepage links to an empty frame. Could the hosted demo (including the gemara-ready/gemara-resize messages) land in gemara-react first, with this PR held as draft until then?
| <img src="{{ '/assets/gemara-logo.png' | relative_url }}" alt="Gemara Logo" class="gemara-logo" /> | ||
|
|
||
| **GRC Engineering Model for Automated Risk Assessment** | ||
| **[GRC](model/02-definitions.html#grc) Engineering Model for Automated [Risk Assessment](model/02-definitions.html#risk-assessment)** |
There was a problem hiding this comment.
🤖 (medium)
These glossary links are termlinker output from make gendocs, which adds them at build time. Committing them would double them up on the next build. Could you run make cleanup-links so the diff only has the demo changes?
| id="gemara-demo-frame" | ||
| src="https://gemaraproj.github.io/gemara-react/" | ||
| title="Gemara React Live Artifact Renderer Demo" | ||
| sandbox="allow-scripts allow-same-origin" |
There was a problem hiding this comment.
🤖 (medium)
allow-scripts with allow-same-origin together let the framed page lift its own sandbox, so "strict sandbox isolation" overstates it. Does the demo need allow-same-origin?
Signed-off-by: PaarthPandey10 <paarthdxb@gmail.com>
5a58418 to
304fdc6
Compare
|
Thanks for the thorough review @jmeridth! I've addressed all four points:
|
Closes #6
Summary
Adds an interactive
@gemara/reactlive demo page at/sdk/demo.html(sdk/demo.md) that embeds the hosted@gemara/reactdemo via a sandboxed<iframe>, keeping this repository strictly Jekyll + Go with zero Node toolchain dependencies.Changes
sdk/demo.md: Embedshttps://gemaraproj.github.io/gemara-react/inside a strict<iframe sandbox="allow-scripts">container withpostMessagesupport for light/dark theme synchronization (gemara-theme) and dynamic height resizing (gemara-resize), plus fallback links and quick-start usage examples._data/navigation.yml), the SDK sidebar (_data/sidebar.yml), the SDK index and React SDK docs (sdk/index.md,sdk/react-sdk.md), and the homepage Quick Start section (index.md).Deployment Order
Held as Draft until the companion GitHub Pages demo workflow and
gemara-ready/gemara-resize/gemara-themepostMessagehandlers land ingemaraproj/gemara-react.