Skip to content

docs(agents): complete packages table in glossary (13 → 27)#400

Open
brianmhunt wants to merge 1 commit into
mainfrom
claude/glossary-all-packages
Open

docs(agents): complete packages table in glossary (13 → 27)#400
brianmhunt wants to merge 1 commit into
mainfrom
claude/glossary-all-packages

Conversation

@brianmhunt

@brianmhunt brianmhunt commented Jun 3, 2026

Copy link
Copy Markdown
Member

Summary

  • Expands the tko.io/public/agents/glossary.md Packages table from 13 → 27 entries, covering every @tko/* package in the monorepo
  • Adds 14 missing packages grouped by logical area: lifecycle, bindings, utils, providers, filters

New rows added:

Package Purpose
@tko/lifecycle Subscription and disposal tracking mixin
@tko/binding.component Component binding for custom elements
@tko/utils.component Component registry, loaders, and ComponentABC base class
@tko/utils.functionrewrite Rewrites function expressions as arrow functions for binding
@tko/utils.jsx JSX/TSX rendering: createElement, Fragment, JsxObserver
@tko/utils.parser CSP-safe expression parser for data-bind attributes
@tko/provider.attr Binds ko-* HTML attributes to binding handlers
@tko/provider.bindingstring Abstract base for binding string parsers
@tko/provider.component Binding provider for custom web component elements
@tko/provider.multi Combines multiple binding providers into one
@tko/provider.mustache Mustache-style {{ }} interpolation in HTML
@tko/provider.native Binding provider for values set directly on DOM nodes (JSX/TSX)
@tko/provider.virtual Binding provider for <!-- ko --> virtual elements
@tko/filter.punches Knockout-punches expression filters for binding strings

Why

The previous table left 14 packages undocumented, including @tko/lifecycle (referenced 7+ times in guide.md) and the full provider sub-family. An agent reading only the glossary had no import path or description for these packages and had to fall back to searching the codebase.

Verification

  • All 14 package directories confirmed present under packages/
  • All npm names verified against each package's package.json name field
  • All descriptions cross-checked against package.json description + index.ts exports
  • Independent adversarial review found no errors

Test plan

  • tko.io Astro build succeeds (bun run build in tko.io/)
  • No broken links or references introduced (pure table addition)

https://claude.ai/code/session_01YJFLWTNLq2tJvciHW4FEC5


Generated by Claude Code

Summary by CodeRabbit

  • Documentation
    • Expanded the packages section in the glossary with additional package entries for improved reference.

Adds 14 missing @tko/* packages to the agent-facing glossary table,
bringing coverage from 13 to 27 packages (all packages in the monorepo).
Added: lifecycle, binding.component, utils.component,
utils.functionrewrite, utils.jsx, utils.parser, provider.attr,
provider.bindingstring, provider.component, provider.multi,
provider.mustache, provider.native, provider.virtual, filter.punches.

Adversarial audit: all 14 package names verified against package.json
name fields; all descriptions checked against package.json + index.ts;
all directories confirmed present on this branch.

https://claude.ai/code/session_01YJFLWTNLq2tJvciHW4FEC5
Copilot AI review requested due to automatic review settings June 3, 2026 15:14
@coderabbitai

coderabbitai Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2760dd9b-bb89-45ff-bc95-7942d901bff5

📥 Commits

Reviewing files that changed from the base of the PR and between 60fd093 and e3aa292.

📒 Files selected for processing (1)
  • tko.io/public/agents/glossary.md

📝 Walkthrough

Walkthrough

The PR expands the "Packages" section in the TKO glossary documentation to provide a more comprehensive list of available @tko/* monorepo packages, including lifecycle management, binding utilities, component utilities, provider implementations, and filters.

Changes

Glossary Package Documentation

Layer / File(s) Summary
Packages list expansion
tko.io/public/agents/glossary.md
The "Packages" table is expanded to document additional @tko/* monorepo packages including lifecycle, binding.component, utils (component, functionrewrite, jsx), multiple provider implementations, builder, and filter.punches.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

📚✨ A glossary grows with every package name,
Like carrots in a row, each one the same,
@tko utilities bundled with care,
Lifecycle and bindings beyond compare! 🐰

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: expanding a documentation table from 13 to 27 package entries, which is the primary objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/glossary-all-packages

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the agent-facing glossary to fully enumerate the monorepo’s public @tko/* packages, so readers can quickly discover the correct import paths and high-level roles without codebase searching.

Changes:

  • Expands the “Packages” table in tko.io/public/agents/glossary.md from 13 to 27 entries.
  • Adds missing package rows across lifecycle, component bindings, utils, providers, and filters.
  • Keeps the existing table structure and formatting consistent while increasing coverage.

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.

4 participants