Skip to content

Present OpenGeometry for every field and use the new logo - #56

Merged
aka-blackboots merged 2 commits into
mainfrom
docs/readme-for-every-use
Nov 10, 2026
Merged

aka-blackboots merged 2 commits into
mainfrom
docs/readme-for-every-use

Conversation

@aka-blackboots

Copy link
Copy Markdown
Contributor

Summary

README for every field, not only buildings

  • The tagline and "What is OpenGeometry?" say what the kernel does and who uses it, including Node.js.
  • A new "Use cases" table: product configurators, mechanical parts, manufacturing, architecture and construction, robotics, AI agents and prompt-to-CAD, education, and server-side STEP generation. Each row names the 3.0 features that serve it.
  • The overlapping "When to use", "Why AI", "Good fit" and "Who is this for" sections become that table and a short "When not to use it".
  • A section for AI agents links llms.txt and the "Use a coding agent" page, ahead of the one-page API reference.
  • The quick start makes a 120 × 80 × 10 mm mounting plate with four bolt holes in one boolean call and exports it as STEP in millimetres, in place of the wall and door. The browser quick-start page and its spec follow it (14 STEP faces and the plate's bounds).
  • The example list names the new shape pages.
  • The npm description and keywords name the same fields.

New logo

  • README banner: the new logo on a clear background, with a white version for GitHub dark mode.
  • Docs: a horizontal version in the navbar (light and dark), the new mark as favicon, and a 1200 × 630 share image with a large card.
  • The old logo files and favicon are removed.

Verification

  • README, package and dist tests: 58 pass, including the type check of the new quick start.
  • The quick-start browser test passes in Chromium.
  • npm run check in docs/: format, index, strict validation and links pass.
  • The docs navbar logo checked locally in light and dark mode.

The README opens with what the kernel does and who uses it: a table of
use cases from product configurators and mechanical parts to robotics,
AI agents and server-side STEP generation. The overlapping "when to
use", "good fit" and "who is this for" sections become that table and a
short "when not to use it". A section for AI agents links llms.txt and
the agents page ahead of the one-page API reference.

The quick start makes a mounting plate with four bolt holes in one
boolean call and exports it as STEP in millimetres, in place of the wall
and door. The browser quick-start page and its spec follow it: 14 STEP
faces and the plate's bounds. The example list names the new shape
pages.

The npm description and keywords name the same fields so the package is
found for them.
The README banner is the new logo, black on a clear background, with a
white version for dark mode. The docs navbar uses a horizontal version
of the same logo in light and dark, the favicon is the new mark, and the
docs share a 1200 by 630 preview image with a large card. The old logo
files and favicon are removed.
@aka-blackboots
aka-blackboots merged commit 259030f into main Nov 10, 2026
2 of 6 checks passed
@aka-blackboots
aka-blackboots deleted the docs/readme-for-every-use branch November 10, 2026 22:03
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.

1 participant