Repository navigation
Present OpenGeometry for every field and use the new logo - #56
Merged
Merged
Conversation
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.
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
README for every field, not only buildings
llms.txtand the "Use a coding agent" page, ahead of the one-page API reference.New logo
Verification
npm run checkindocs/: format, index, strict validation and links pass.