Add core API documentation and update navigation structure#8
Open
bhairaav wants to merge 2 commits into
Open
Conversation
- Add api/core/opengeometry.mdx — documents the OpenGeometry class (create, version, instance, enableDebug) extracted from index.ts - Add api/core/vector3.mdx — documents the wasm-backed Vector3 type - Add api/scene/spot-label.mdx — documents the SpotLabel CSS2D marker - Add OUTLINE_TYPE type definition to api/export/projection.mdx - Remove bogus demo link from api/export/ifc.mdx (no demo exists) - Fix broken internal links in api/scene/scene-management.mdx (missing /OpenGeometry/ product prefix) - Add projection, scene-management, spot-label, opengeometry, vector3 to docs.json navigation; add "Scene" and "Core" groups - Sync .atlas-analysis.json with current API surface and nav structure https://claude.ai/code/session_01LfFsmHz67gxarN59GMQYSt
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.
Summary
This PR adds comprehensive documentation for the core OpenGeometry API and reorganizes the documentation navigation to better reflect the library's architecture and user workflows.
Key Changes
New Documentation Pages
api/core/opengeometry.mdx— Documents theOpenGeometrysingleton class, including initialization viacreate(), theenableDebugproperty for debug rendering, version information, and code examples for basic setup and debug mode usageapi/core/vector3.mdx— Documents theVector3wasm-backed 3D coordinate type, including constructor parameters and usage examples with primitives and shapesapi/scene/spot-label.mdx— Documents theSpotLabelCSS2D markup component for annotating points on geometry in Three.js scenesNavigation & Configuration Updates
Reorganized
.atlas-analysis.jsonnavigation structure:opengeometryandvector3api/shapes/openingandapi/operations/boolean-operationsto shape/operation listspublicApiSurfaceto reflect current exports (OpenGeometry, Vector3, OGSceneManager, SpotLabel, export types)extractedAt,sourceRef,entryFileUpdated theme colors in
.atlas-analysis.json:lightColoranddarkColorto#4460FF(previouslynull)Updated
docs.jsonto mirror navigation changes with new "Core" and reorganized "Scene" groupsDocumentation Improvements
scene-management.mdxto use full paths (/OpenGeometry/api/...)OUTLINE_TYPEtype definition documentation inprojection.mdxMiscellaneous
.gitignorewithnode_modules/entryImplementation Details
The documentation follows the existing Mintlify format with parameter fields, response fields, code examples, and cross-reference cards. The
OpenGeometryandVector3docs emphasize the initialization dependency (wasm module must be loaded before constructing Vector3), which is a critical constraint for users.https://claude.ai/code/session_01LfFsmHz67gxarN59GMQYSt