opengeometry 2.0.8 → 2.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,5 +1,5 @@
1
1
  <p align="center">
2
- <a href="https://opengeometry.io">
2
+ <a href="https://opengeometry.io?utm_source=github">
3
3
  <img src="https://raw.githubusercontent.com/OpenGeometry-io/.github/main/profile/opengeometryTextLogo.png" alt="OpenGeometry" />
4
4
  </a>
5
5
  </p>
@@ -7,24 +7,24 @@
7
7
  <h1 align="center">OpenGeometry</h1>
8
8
 
9
9
  <p align="center">
10
- <strong>Browser-native CAD kernel built with Rust, WebAssembly, and Three.js.</strong>
10
+ <strong>Browser-native CAD kernel for Web Apps and AI CAD built with Rust, WebAssembly, and Three.js.</strong>
11
11
  </p>
12
12
 
13
13
  <p align="center">
14
14
  <a href="https://www.npmjs.com/package/opengeometry"><img src="https://img.shields.io/npm/v/opengeometry?style=flat-square&color=4460FF&label=npm" alt="npm version" /></a>
15
15
  <a href="https://github.com/OpenGeometry-io/OpenGeometry/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/opengeometry-io/opengeometry?style=flat-square" alt="License" /></a>
16
- <a href="https://discord.com/invite/cZY2Vm6E"><img src="https://img.shields.io/badge/Discord-Join%20us-5865F2?style=flat-square&logo=discord&logoColor=white" alt="Discord" /></a>
16
+ <a href="https://discord.gg/9wJpbfgGGA"><img src="https://img.shields.io/badge/Discord-Join%20us-5865F2?style=flat-square&logo=discord&logoColor=white" alt="Discord" /></a>
17
17
  <a href="https://x.com/openGeometry"><img src="https://img.shields.io/badge/Twitter-Follow-1DA1F2?style=flat-square&logo=x&logoColor=white" alt="Twitter" /></a>
18
18
  <a href="https://linkedin.com/company/openGeometry"><img src="https://img.shields.io/badge/LinkedIn-Connect-0A66C2?style=flat-square&logo=linkedin&logoColor=white" alt="LinkedIn" /></a>
19
19
  </p>
20
20
 
21
21
  <p align="center">
22
- <a href="https://opengeometry.io">Website</a> · <a href="https://docs.opengeometry.io">Documentation</a> · <a href="https://demo.opengeometry.io">Live Demos</a> · <a href="https://opengeometry.io/blog">Blog</a> · <a href="https://www.npmjs.com/package/opengeometry">npm</a>
22
+ <a href="https://opengeometry.io?utm_source=github">Website</a> · <a href="https://docs.opengeometry.io/OpenGeometry?utm_source=github">Documentation</a> · <a href="https://demos.opengeometry.io?utm_source=github">Live Demos</a> · <a href="https://blog.opengeometry.io?utm_source=github">Blog</a> · <a href="https://www.npmjs.com/package/opengeometry">npm</a>
23
23
  </p>
24
24
 
25
25
  ---
26
26
 
27
- > **Actively maintained and growing.** We're building OpenGeometry in the open. APIs, examples, and package structure are evolving, we are actively improving and expanding the project. Star the repo to follow along. If you have questions or want to get involved, join the [Discord](https://discord.com/invite/cZY2Vm6E) or check out the [issues](https://github.com/OpenGeometry-io/OpenGeometry/issues)
27
+ > **Actively maintained and growing.** We're building OpenGeometry in the open. APIs, examples, and package structure are evolving, we are actively improving and expanding the project. Star the repo to follow along. If you have questions or want to get involved, join the [Discord](https://discord.com/invite/9wJpbfgGGA) or check out the [issues](https://github.com/OpenGeometry-io/OpenGeometry/issues)
28
28
 
29
29
  ---
30
30
 
@@ -55,15 +55,15 @@ Good examples include:
55
55
 
56
56
  - AI copilots that translate user intent into concrete modeling operations
57
57
  - prompt-to-geometry or agent-driven editing flows inside browser CAD tools
58
- - AI-assisted design interfaces that still need reliable extrusion, boolean, projection, and export workflows
58
+ - AI first design interfaces that still need reliable extrusion, boolean, projection, and export workflows
59
59
 
60
60
  ## Good fit / Not the right fit
61
61
 
62
62
  **Good fit**
63
63
 
64
- - browser CAD, AEC/BIM, and geometry-heavy web applications
64
+ - browser CAD, AEC/BIM, Mechanical, and geometry-heavy web applications
65
65
  - Three.js-based modeling tools that need a real kernel behind them
66
- - AI-assisted CAD frontends that need deterministic geometry execution in the browser
66
+ - AI first CAD frontends that need deterministic geometry execution in the browser
67
67
 
68
68
  **Not the default fit**
69
69
 
@@ -77,10 +77,10 @@ If you are using ChatGPT, Claude, Gemini, Copilot, or other coding agents on thi
77
77
 
78
78
  - [AGENTS.md](./AGENTS.md) - single source of truth for all coding agents (architecture, commands, gotchas, behavioral rules)
79
79
  - [README.md](./README.md) - product overview, positioning, and quick start
80
- - [Quickstart](https://docs.opengeometry.io/quickstart)
81
- - [Three.js integration](https://docs.opengeometry.io/integration/threejs)
82
- - [Boolean operations](https://docs.opengeometry.io/api/operations/boolean-operations)
83
- - [Extrude](https://docs.opengeometry.io/api/operations/extrude)
80
+ - [Quickstart](https://docs.opengeometry.io/OpenGeometry/quickstart)
81
+ - [Installation](https://docs.opengeometry.io/OpenGeometry/installation)
82
+ - [Boolean operations](https://docs.opengeometry.io/OpenGeometry/concepts/booleans)
83
+ - [Extrude](https://docs.opengeometry.io/OpenGeometry/api/operations/extrude)
84
84
 
85
85
  ### What you can do today
86
86
 
@@ -96,7 +96,7 @@ If you are using ChatGPT, Claude, Gemini, Copilot, or other coding agents on thi
96
96
 
97
97
  See OpenGeometry in action — interactive, browser-based demos showcasing the kernel's capabilities:
98
98
 
99
- **[demo.opengeometry.io](https://demo.opengeometry.io)**
99
+ **[demos.opengeometry.io](https://demos.opengeometry.io)**
100
100
 
101
101
  Demos include primitives rendering, shape generation, sweep operations, boolean operations, file exports, and more. All running client-side via WebAssembly.
102
102
 
@@ -139,7 +139,7 @@ cuboid.setPlacement({
139
139
 
140
140
  Scenegraph behavior is snapshot-based: `add*ToScene` captures geometry at insert time. If you change placement/config later, push updates explicitly via `replaceBrepEntityInScene` or `refreshBrepEntityInScene`.
141
141
 
142
- For a complete walkthrough, see the [Quick Start guide](https://docs.opengeometry.io/quickstart) or clone the [quickstart-js](https://github.com/OpenGeometry-io/quickstart-js) repo.
142
+ For a complete walkthrough, see the [Quick Start guide](https://docs.opengeometry.io/OpenGeometry/quickstart) or clone the [quickstart-js](https://github.com/OpenGeometry-io/quickstart-js) repo.
143
143
 
144
144
  ## Documentation
145
145
 
@@ -148,10 +148,10 @@ Full API reference, guides, and concepts are available at:
148
148
  **[docs.opengeometry.io](https://docs.opengeometry.io)**
149
149
 
150
150
  Key pages:
151
- - [Installation](https://docs.opengeometry.io/installation)
152
- - [Quick Start](https://docs.opengeometry.io/quickstart)
153
- - [Architecture & Concepts](https://docs.opengeometry.io/concepts/architecture)
154
- - [API Reference](https://docs.opengeometry.io/api)
151
+ - [Installation](https://docs.opengeometry.io/OpenGeometry/installation)
152
+ - [Quick Start](https://docs.opengeometry.io/OpenGeometry/quickstart)
153
+ - [Architecture & Concepts](https://docs.opengeometry.io/OpenGeometry/concepts/architecture)
154
+ - [API Reference](https://docs.opengeometry.io/OpenGeometry/api/)
155
155
 
156
156
  ## Repository Structure
157
157
 
@@ -165,7 +165,7 @@ docs/ Documentation source (Mintlify)
165
165
 
166
166
  ## Building from Source
167
167
 
168
- **Prerequisites:** Node.js, npm, Rust toolchain, `wasm-pack`
168
+ **Prerequisites:** Node.js, npm, Rust 1.89.0+ with `wasm32-unknown-unknown`, `wasm-pack`
169
169
 
170
170
  ```bash
171
171
  # Install dependencies
@@ -191,28 +191,25 @@ npm test
191
191
  - Contributors interested in the **Rust → WASM geometry pipeline**
192
192
  - Anyone exploring **open-source CAD kernel internals**
193
193
 
194
- If you just want a quick look, start with the [hosted demos](https://demo.opengeometry.io) or the [quickstart repo](https://github.com/OpenGeometry-io/quickstart-js).
194
+ If you just want a quick look, start with the [hosted demos](https://demos.opengeometry.io) or the [quickstart repo](https://github.com/OpenGeometry-io/quickstart-js).
195
195
 
196
196
  ## Community
197
197
 
198
198
  We'd love to have you involved — whether you're using OpenGeometry, building on it, or just curious.
199
199
 
200
- - **[Discord](https://discord.com/invite/cZY2Vm6E)** — Chat with the team and community
200
+ - **[Discord](https://discord.com/invite/9wJpbfgGGA)** — Chat with the team and community
201
201
  - **[Twitter / X](https://x.com/openGeometry)** — Updates and announcements
202
202
  - **[LinkedIn](https://linkedin.com/company/openGeometry)** — Company updates
203
203
  - **[GitHub Issues](https://github.com/OpenGeometry-io/OpenGeometry/issues)** — Bug reports and feature requests
204
- - **[Blog](https://opengeometry.io/blog)** — Deep dives and release notes
204
+ - **[Blog](https://blog.opengeometry.io?utm_source=github)** — Deep dives and release notes
205
205
 
206
206
  ## Contributing
207
207
 
208
- OpenGeometry is open source under the [MPL-2.0 license](./LICENSE.md). Contributions are welcome — check the [issues](https://github.com/OpenGeometry-io/OpenGeometry/issues) for good starting points or open a discussion on [Discord](https://discord.com/invite/cZY2Vm6E).
208
+ OpenGeometry is open source under the [MPL-2.0 license](./LICENSE.md). Contributions are welcome — check the [issues](https://github.com/OpenGeometry-io/OpenGeometry/issues) for good starting points or open a discussion on [Discord](https://discord.com/invite/9wJpbfgGGA).
209
209
 
210
210
  ## AI Agent Docs Policy
211
211
 
212
- - All AI coding agent instructions live in a single file: [AGENTS.md](./AGENTS.md).
213
- `CLAUDE.md` and `.github/copilot-instructions.md` are thin redirects to it.
214
- - Stable architecture and domain notes are tracked in [`knowledge/`](./knowledge/).
215
- - User-facing docs live in [`docs/`](./docs/) (Mintlify source).
212
+ - If you're an AI agent, start with [AGENTS.md](./AGENTS.md) for architecture, commands, and behavioral rules.
216
213
  - Agents should not create planning, handoff, or runbook files during a task. The
217
214
  conversation, the diff, and the commit message are the handoff.
218
215