Skip to content

docs: reconcile component vocabulary with implemented components - #171

Open
zpyoung wants to merge 1 commit into
mainfrom
claude/fervent-feynman-nful81
Open

zpyoung wants to merge 1 commit into
mainfrom
claude/fervent-feynman-nful81

Conversation

@zpyoung

@zpyoung zpyoung commented Jul 20, 2026

Copy link
Copy Markdown
Owner

Summary

docs/component-vocabulary.md had drifted from src/components/index.js: several components that are implemented and exported were still listed as "Planned", and two others were entirely undocumented. This PR reconciles the reference (and its wiki mirror) with the actual implementation.

Changes

  • Promoted three components from "Planned" → "Supported" with accurate attribute tables, behavior, accessibility, and trust notes:
    • <agent-copy-block> (label, lang)
    • <agent-tabs> / <agent-tab> (label; title, active)
    • <agent-timeline> / <agent-step>
  • Corrected the <agent-step> spec to match src/components/agent-timeline.js:
    • uses label, not title
    • has no time attribute
    • status vocabulary is done | active | pending | failed (unknown values fall back to pending), replacing the incorrect todo/doing/blocked/skipped
    • <agent-timeline> documented with label (default Timeline)
  • Documented <agent-action-list> / <agent-action> (previously undocumented): list attrs label, layout (table/kanban/priority), group-by (status/priority), filter-status, filter-priority, show-done; item attrs owner, due, priority (high→P0, normal→P1, low→P2), status (open/in-progress/blocked/done). Noted that the item's visible label comes from body text and that filters/group-by apply to the table layout.
  • Documented <agent-proceed> (previously undocumented): label (default Proceed →), allow-empty; the document-level agent-isles:select listener; the composed agent-isles:proceed event carrying { type, selected, text }; and the disabled-until-selected / processing states.
  • Mirrored all of the above to docs/wiki/Component-Vocabulary.md.

<agent-finding> is the only component that remains under "Planned" — verified it is not exported from src/components/index.js.

Verification

Documentation-only change. Every attribute table was written against the component source (agent-copy-block.js, agent-tabs.js, agent-timeline.js, agent-action-list.js, agent-proceed.js) and cross-checked against real usage in examples/demo.md. There is no automated test that validates this doc against index.js, so there is no build/test to exercise these edits.

🤖 Generated with Claude Code

https://claude.ai/code/session_01RjhixerKDdj4Fg5NuqHwk4


Generated by Claude Code

Fix drift between docs/component-vocabulary.md and src/components/index.js:

- Move <agent-copy-block>, <agent-tabs>/<agent-tab>, and
  <agent-timeline>/<agent-step> from "Planned components" to
  "Supported components" with accurate attribute tables, behavior,
  accessibility, and trust notes.
- Correct <agent-step>: uses `label` (not `title`), has no `time`
  attribute, and its status vocabulary is done|active|pending|failed
  (unknown -> pending), not todo/doing/blocked/skipped.
- Document previously-undocumented <agent-action-list>/<agent-action>
  (layout, group-by, filter-status, filter-priority, show-done; item
  owner/due/priority/status; body text as the visible label).
- Document previously-undocumented <agent-proceed> (label, allow-empty;
  agent-isles:select listener; composed agent-isles:proceed event;
  disabled-until-selected and processing states).

Mirror all changes to docs/wiki/Component-Vocabulary.md.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RjhixerKDdj4Fg5NuqHwk4
Copilot AI review requested due to automatic review settings July 20, 2026 23:09

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

This PR updates the Agent Isles component vocabulary documentation (and its wiki mirror) to better match the currently implemented/exported <agent-*> components, promoting several components to “supported” and adding missing component docs.

Changes:

  • Added/expanded “supported” documentation for <agent-copy-block>, <agent-tabs>/<agent-tab>, and <agent-timeline>/<agent-step>.
  • Added new documentation for <agent-action-list>/<agent-action> and <agent-proceed>.
  • Reorganized “Planned components” so <agent-finding> remains listed as planned.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.

File Description
docs/component-vocabulary.md Updates the canonical component vocabulary reference, adding/expanding docs for supported components and moving the planned section.
docs/wiki/Component-Vocabulary.md Mirrors the same vocabulary changes into the repo-tracked wiki page.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Each `<agent-step>` contains concise details, links, or evidence for that step.

Accessibility notes:

<agent-timeline label="Autopilot run">
<agent-step status="done" label="Inspected issue">
Confirmed #10 was ready and no existing PR targeted it.
</agent-step>
Confirmed #10 was ready and no existing PR targeted it.
</agent-step>
<agent-step status="doing" title="Open PR">
<agent-step status="active" label="Open PR">
Authoring guidance:

- Use `<agent-action-list>` for the container and direct `<agent-action>` children for items.
- Put the visible action text in the element body; `<agent-action>` has no label attribute, and items with empty body text are skipped.

Child content:

- `<agent-action-list>` should contain direct `<agent-action>` children.

Example:

```markdown
Example:

```markdown
<agent-action-list label="Launch follow-ups" layout="table" group-by="status" filter-status="open,in-progress,blocked" show-done="false">

### `<agent-proceed>`

Use as the deliberate "go" / commit control on live brainstorming screens: readers explore options with `<agent-option-set>`/`<agent-choice>`, then advance with `<agent-proceed>`.

This branch has not been deployed

No deployments
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.

3 participants