docs: context7 documentation + config (closes #7)#8
Merged
Conversation
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.
Closes #7.
Adds context7-compliant documentation for the C API (this is a C/C++ library, not Swift) plus a root
context7.json. There was previously nodocs/directory — this PR creates one.Files
context7.json—projectTitle: simpleOCCTVP;folders: ["docs","src"];excludeFolders: ["build",".build","okf","tests"]; 7 rules covering shared-library linking, the cdeclot_*/occt_templot_*calling convention, opaque handle / lifetime ownership, struct-buffer freeing, and the offscreen render entry point.docs/reference/c-api.md— full C API reference grouped by area (lifecycle, shape handles, shape I/O, healing & analysis, mesh extraction, offscreen render, standalone camera, display drawer). Each function has its exact C signature, description, params, return/ownership semantics, and runnable C snippets, plus a Pascal-binding example.docs/guides/getting-started.md— runnable C walkthrough: link the shared lib, load a shape, extract a mesh, render a PNG, with per-platform compile/link commands.Grounding & verification
src/occt_templot.h(verified against the header — zero invented APIs).pascal/occt_templot.pas.context7.jsonis valid JSON;descriptionis 193 chars (≤200); every rule is ≤255 chars.Render markers (TODO)
This library does offscreen rendering, but no PNGs are produced in this PR. Each render example carries an inline
<!-- 3D render TODO: example rendered PNG -->marker where a rendered image should later be embedded. No nonexistent image links were added.🤖 Generated with Claude Code