Skip to content

refactor(skills): consolidate hooks documentation to eliminate duplication#1136

Merged
xuyushun441-sys merged 1 commit intomainfrom
claude/refactor-skills-to-use-hooks
Apr 14, 2026
Merged

refactor(skills): consolidate hooks documentation to eliminate duplication#1136
xuyushun441-sys merged 1 commit intomainfrom
claude/refactor-skills-to-use-hooks

Conversation

@Claude
Copy link
Copy Markdown
Contributor

@Claude Claude AI commented Apr 14, 2026

Hooks documentation was duplicated across objectstack-schema (1038 lines) and objectstack-plugin (358 lines), causing maintenance burden and potential inconsistencies. This refactors the documentation structure to establish a single source of truth.

Changes

Revived objectstack-hooks as canonical reference

  • Removed deprecated status
  • Positioned as authoritative source for all hook documentation
  • Version bump 1.0 → 2.0

Created reference structure

objectstack-hooks/
├── SKILL.md                    # Hub with navigation & comparison table
└── references/
    ├── data-hooks.md           # Complete data lifecycle hooks docs
    └── plugin-hooks.md         # Complete plugin/kernel hooks docs

Replaced duplicates with reference pointers

  • objectstack-schema/rules/hooks.md: 1038 lines → 146 lines (quick ref + pointer)
  • objectstack-plugin/rules/hooks-events.md: 358 lines → 164 lines (quick ref + pointer)
  • Reference docs retain quick reference tables and common patterns
  • Clear navigation to full documentation

Updated cross-references

  • All SKILL.md files updated to point to objectstack-hooks
  • Relative link paths verified
  • Consistent reference notation: (→ [objectstack-hooks](...)

Benefits

  • Single source of truth: Updates only needed in one location
  • ~1400 lines of duplication eliminated: Reduced from 3 copies to 1 canonical + 2 lightweight references
  • Improved discoverability: Central hub for all hook documentation
  • Consistent information: No risk of divergent documentation

Pattern established

This approach can be applied to other duplicated content (validation rules, field types, naming conventions) to maintain documentation quality across the skills ecosystem.

…ation

- Revived objectstack-hooks skill as canonical reference (removed deprecation)
- Created objectstack-hooks/references/ with data-hooks.md and plugin-hooks.md
- Replaced objectstack-schema/rules/hooks.md with reference pointer
- Replaced objectstack-plugin/rules/hooks-events.md with reference pointer
- Updated all cross-references in SKILL.md files
- Established single source of truth for all hooks documentation

Agent-Logs-Url: https://github.com/objectstack-ai/framework/sessions/121cb9bd-5a46-4612-bc44-314fe4196da5

Co-authored-by: xuyushun441-sys <255036401+xuyushun441-sys@users.noreply.github.com>
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 14, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
objectstack-demo Ready Ready Preview, Comment Apr 14, 2026 7:38am
objectstack-play Ready Ready Preview, Comment Apr 14, 2026 7:38am
spec Ready Ready Preview, Comment Apr 14, 2026 7:38am

Request Review

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 14, 2026
@xuyushun441-sys xuyushun441-sys marked this pull request as ready for review April 14, 2026 07:39
@xuyushun441-sys xuyushun441-sys merged commit f55bdef into main Apr 14, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/xl

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants