بنقرة واحدة
sync-plugin-docs
Regenerate plugin-docs/CLAUDE.md from source code and agent-notes to prevent documentation drift.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
القائمة
Regenerate plugin-docs/CLAUDE.md from source code and agent-notes to prevent documentation drift.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | sync-plugin-docs |
| description | Regenerate plugin-docs/CLAUDE.md from source code and agent-notes to prevent documentation drift. |
| allowed-tools | Read, Glob, Grep, Write, Bash(git*) |
Regenerate plugin-docs/CLAUDE.md — the consumer-facing plugin reference deployed to vaults via /local-deploy.
The exported plugin-docs/CLAUDE.md is the agent memory for any vault consuming this plugin. Its purpose is to give agents enough context to utilize and manipulate Powerbase effectively within an Obsidian project — configuring .base files, setting up relations/rollups/bidi sync, editing views programmatically, and troubleshooting issues without trial and error.
The plugin source code lives at https://github.com/ran-codes/obsidian-powerbase. The exported doc MUST include this repo URL and a note telling consumer agents that the main branch of this repository is the source of truth for plugin behavior. If agents need details beyond what the exported doc covers (e.g., edge cases, internal logic, undocumented behavior), they should examine the repository's main branch directly.
If the exported doc drifts from the source code, agents make wrong assumptions about config format, detection behavior, etc. (e.g., putting config inside options: instead of view-level flat keys). This skill prevents that drift by regenerating docs from the actual source code and agent-notes.
Detect the current version by listing folders in .claude/reference/ and picking the most recent semantic version (e.g., v0.1, v0.2). Use this version to:
.claude/reference/<version>/agent-notes/.claude/reference/<version>/adr/<!-- Powerbase docs <version> -->Read these in order to build the exported doc. Never invent — only document what the code actually does.
Scan these files for current behavior:
| File | What to extract |
|---|---|
src/relational-table-view.ts | detectRelationColumn() — active detection patterns; getRollupConfigs() / getBidiConfigs() / getQuickActionConfigs() — config key names; getBaseFolder() — folder resolution logic; getViewOptions() — available config panel options; detectColumnType() — column type inference |
src/services/RollupService.ts | aggregate() — aggregation type names and behavior |
src/services/BidirectionalSyncService.ts | Sync mechanism |
src/services/EditEngineService.ts | Write queue timing |
src/services/ParseService.ts | WIKILINK_REGEX, value formatting |
src/types.ts | Type definitions for configs |
Read all files in .claude/reference/<version>/agent-notes/. Each note describes a specific gotcha that MUST be reflected in the exported doc. These are hard-won lessons — never omit them.
Scan .claude/reference/<version>/adr/ for any decisions that affect consumer-facing behavior.
Write to plugin-docs/CLAUDE.md with this structure:
# Powerbase — Plugin Reference
## What This Plugin Adds (vs Vanilla Bases)
## View Setup
## Property ID Conventions
## Configuration
→ CRITICAL: explain that config keys are VIEW-LEVEL FLAT KEYS, not inside options:
→ Show correct .base YAML examples (not JSON, not nested in options)
## Feature Reference
### Relation Columns
### Rollup Columns
### Bidirectional Sync
### Quick Actions
### Date / Datetime Columns
### Priority Enhanced UI
### Column Context Menu
### File Context Menu
### Group-By
### Inline Editing
## Complete .base Example
→ Must use correct YAML format with view-level flat keys
## Agent Notes
→ Summarize each file from agent-notes/ as a subsection
## Troubleshooting
.base files are YAML. All examples must be YAML.rollupCount, rollup1_relation, bidiCount, quickActions, colType_*, priorityEnhanced_*) go as sibling keys to order, sort, groupBy on the view object. NEVER show them inside options:.detectRelationColumn() only uses folder matching, document only folder matching. Count the patterns in the actual function, don't copy from old docs.agent-notes/ must appear in the Agent Notes section./local-deploy to push the updated docs to their vault