Add pages: how to publish JS API and create a new topic - #61
Open
engbergandreas wants to merge 6 commits into
Open
Add pages: how to publish JS API and create a new topic#61engbergandreas wants to merge 6 commits into
engbergandreas wants to merge 6 commits into
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
A couple of documentation details are misleading/incorrect (API landing page wording/link casing consistency, and the “stable promotion” dist-tag guidance).
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR extends the developer contribution docs by adding a new “OpenSpace API” subsection under Development, with focused guides for creating new OpenSpace Topics and testing/publishing openspace-api-js updates so downstream repos (like WebGUI) can consume generated types.
Changes:
- Adds a new Development navigation entry for API documentation (
contribute/development/api/). - Introduces a Topic-creation walkthrough that ties together engine registration, schema generation, and TypeScript type generation.
- Adds a practical guide for locally testing and publishing
openspace-api-jsprereleases and stable releases.
File summaries
| File | Description |
|---|---|
| contribute/development/index.md | Adds the API section to the Development docs navigation. |
| contribute/development/api/index.md | Introduces the API landing page and JS API toctree entries. |
| contribute/development/api/creating-a-new-topic.md | Documents end-to-end Topic creation + type generation workflow. |
| contribute/development/api/test-and-publish-openspace-api-js.md | Documents local testing via npm pack and publishing workflow. |
Review details
- Files reviewed: 4/4 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
alexanderbock
approved these changes
Sep 8, 2026
Co-authored-by: Alexander Bock <mail@alexanderbock.eu>
WeirdRubberDuck
requested changes
Sep 8, 2026
engbergandreas
requested review from
WeirdRubberDuck
and
a lite review from Copilot
September 9, 2026 12:14
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The new docs include an unresolved TODO section and a likely-invalid MyST admonition syntax that should be corrected before merging.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Review details
- Files reviewed: 5/5 changed files
- Comments generated: 3
- Review effort level: Lite
WeirdRubberDuck
approved these changes
Sep 9, 2026
WeirdRubberDuck
left a comment
WeirdRubberDuck
left a comment
Contributor
There was a problem hiding this comment.
Awesome! Had some suggestions that fix grammatical issues and makes some parts earier to read
Co-authored-by: Emma Broman <emmabroman740@gmail.com>
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.
No description provided.