Skip to content

docs: add LLM-focused API shape audit and recommendations#127

Draft
developit wants to merge 1 commit into
mainfrom
codex/review-kinu-api-and-compare-with-react-toolkits
Draft

docs: add LLM-focused API shape audit and recommendations#127
developit wants to merge 1 commit into
mainfrom
codex/review-kinu-api-and-compare-with-react-toolkits

Conversation

@developit

Copy link
Copy Markdown
Owner

Motivation

  • Provide a focused, LLM-oriented audit of Kinu's public API shape to surface token-level ambiguities and composition inconsistencies.
  • Recommend a minimal, guessable contract so models (and humans) produce correct code from a short prompt and component list.
  • Propose concrete, low-runtime changes and documentation/CI guidance rather than runtime refactors.

Description

  • Add docs/kinu-api-shape-audit.md, a deep review that documents current API topology, nomenclature issues (e.g. commandFor vs commandfor, flat vs namespace exports, alias leakage), an LLM error surface map, and high-impact recommendations.
  • Add docs/kinu-llm-native-recommendations.md, a prescriptive plan that declares canonical rules (Component.Slot namespace in docs, frozen slot vocabulary, HTML-first event names, canonical commandFor spelling), CI/fixture suggestions, rollout phases, and a terse 2-sentence Kinu card.
  • The recommendations prioritize documentation, a small "grammar card", and contract lint/first-try fixture checks over adding heavy metadata or runtime abstractions.

Testing

  • This is a documentation-only change; no automated tests were executed as part of this PR.

Codex Task

@netlify

netlify Bot commented Jun 16, 2026

Copy link
Copy Markdown

Deploy Preview for kinu-sh ready!

Name Link
🔨 Latest commit b218c82
🔍 Latest deploy log https://app.netlify.com/projects/kinu-sh/deploys/6a3139c45cd2960008b84056
😎 Deploy Preview https://deploy-preview-127--kinu-sh.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions

Copy link
Copy Markdown
Contributor

Size Change: 0 B

Total Size: 37.7 kB

ℹ️ View Unchanged
Filename Size
benchmarks/size/.tmp/few-components/bundle.css 3.03 kB
benchmarks/size/.tmp/few-components/bundle.js 637 B
benchmarks/size/.tmp/nearly-all-components/bundle.css 10.9 kB
benchmarks/size/.tmp/nearly-all-components/bundle.js 4 kB
benchmarks/size/.tmp/one-component/bundle.css 1.52 kB
benchmarks/size/.tmp/one-component/bundle.js 341 B
dist/index.css 10.9 kB
dist/index.js 6.34 kB

compressed-size-action

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant