feat(ids): track .aiox-core/core/docs/ in entity registry SCAN_CONFIG - #753
Merged
Conversation
Follow-up to PR #748. The IDS registry's `modules` scan only catches `.aiox-core/core/**/*.{js,mjs}`, so framework documentation under `.aiox-core/core/docs/` was invisible to impact analysis. Operators editing those guides got no signal in `aiox graph`, `*ids` queries, or pre-push validation when references shifted. ## Files added to the registry - `SHARD-TRANSLATION-GUIDE.md` — shard composition reference - `component-creation-guide.md` — meta-agent enhanced template system - `session-update-pattern.md` — session state regen pattern - `template-syntax.md` — handlebars template syntax reference - `troubleshooting-guide.md` — common framework recovery flows Total entities: 816 → 820 (one was already auto-tracked under data; the others are newly visible). ## Implementation - Added `{ category: 'core-docs', basePath: '.aiox-core/core/docs', glob: '**/*.md', type: 'docs' }` to `SCAN_CONFIG`. - Added explicit `docs: 0.5` to `ADAPTABILITY_DEFAULTS` (matches `data` type: reference material, mutable across major project evolution but rarely per-mission). Without this, the script would fall through to the generic 0.5 default — same numeric outcome but the explicit entry documents intent. ## Validation - [x] `npm run lint` → exit 0 - [x] `node .aiox-core/development/scripts/populate-entity-registry.js` reports "Found 5 core-docs" + 100% resolution rate (1289/1289 deps) - [x] All 5 markdown files appear under `entities.core-docs.*` with correct `type: docs` and parsed purposes (e.g. `component-creation-guide` purpose extracted from frontmatter). Closes the 2026-05-17 handoff's Pacote E follow-up. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
rafaelscosta
requested review from
Pedrovaleriolopez and
oalanicolas
as code owners
May 18, 2026 05:37
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughAdds a SCAN_CONFIG rule to register core markdown docs as ChangesDocumentation Registry Configuration
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
Contributor
📊 Coverage ReportCoverage report not available
Generated by PR Automation (Story 6.1) |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.aiox-core/development/scripts/populate-entity-registry.js (1)
822-840: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick winAdd description for 'core-docs' category.
The
getCategoryDescriptionfunction is missing a description entry for the newly addedcore-docscategory. While the fallback prevents runtime errors, adding a description maintains consistency with all other categories and improves clarity for tooling that uses these descriptions.📝 Proposed addition
function getCategoryDescription(category) { const descriptions = { tasks: 'Executable task workflows for agent operations', templates: 'Document and code generation templates', scripts: 'Utility and automation scripts', modules: 'Core framework modules and libraries', agents: 'Agent persona definitions and configurations', checklists: 'Validation and review checklists', data: 'Configuration and reference data files', workflows: 'Multi-phase orchestration workflows', utils: 'Shared utility libraries and helpers', tools: 'Development tool definitions and configurations', 'infra-scripts': 'Infrastructure automation and utility scripts', 'infra-tools': 'Infrastructure tool definitions and configurations', 'product-checklists': 'Product validation and review checklists', 'product-data': 'Product reference data and configuration files', + 'core-docs': 'Framework documentation and reference guides', }; return descriptions[category] || category; }🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.aiox-core/development/scripts/populate-entity-registry.js around lines 822 - 840, The getCategoryDescription function lacks an entry for the new 'core-docs' category; add a mapping in the descriptions object (inside getCategoryDescription) with key 'core-docs' and a concise description (e.g., 'Core documentation and reference guides') so it is handled consistently like other categories.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In @.aiox-core/development/scripts/populate-entity-registry.js:
- Around line 822-840: The getCategoryDescription function lacks an entry for
the new 'core-docs' category; add a mapping in the descriptions object (inside
getCategoryDescription) with key 'core-docs' and a concise description (e.g.,
'Core documentation and reference guides') so it is handled consistently like
other categories.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 21258491-bf3c-4f9b-a094-c48a2007eeec
📒 Files selected for processing (3)
.aiox-core/data/entity-registry.yaml.aiox-core/development/scripts/populate-entity-registry.js.aiox-core/install-manifest.yaml
The previous test pinned `SCAN_CONFIG.length` at 14 (10 original + 4 NOG-16A). Adding `core-docs` raises the count to 15. Test name and assertions updated accordingly. Added a type/basePath assertion for the new `core-docs` entry alongside the existing checks. Suite: 96/96 pass (was 95/95 — net unchanged in pass count because the pinning test simply changed its expectation). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced May 18, 2026
5 tasks
tuanmedeiros
pushed a commit
to tuanmedeiros/aios-core-synkraay
that referenced
this pull request
Jun 2, 2026
…SynkraAI#753) * feat(ids): track .aiox-core/core/docs/ in entity registry SCAN_CONFIG Follow-up to PR SynkraAI#748. The IDS registry's `modules` scan only catches `.aiox-core/core/**/*.{js,mjs}`, so framework documentation under `.aiox-core/core/docs/` was invisible to impact analysis. Operators editing those guides got no signal in `aiox graph`, `*ids` queries, or pre-push validation when references shifted. ## Files added to the registry - `SHARD-TRANSLATION-GUIDE.md` — shard composition reference - `component-creation-guide.md` — meta-agent enhanced template system - `session-update-pattern.md` — session state regen pattern - `template-syntax.md` — handlebars template syntax reference - `troubleshooting-guide.md` — common framework recovery flows Total entities: 816 → 820 (one was already auto-tracked under data; the others are newly visible). ## Implementation - Added `{ category: 'core-docs', basePath: '.aiox-core/core/docs', glob: '**/*.md', type: 'docs' }` to `SCAN_CONFIG`. - Added explicit `docs: 0.5` to `ADAPTABILITY_DEFAULTS` (matches `data` type: reference material, mutable across major project evolution but rarely per-mission). Without this, the script would fall through to the generic 0.5 default — same numeric outcome but the explicit entry documents intent. ## Validation - [x] `npm run lint` → exit 0 - [x] `node .aiox-core/development/scripts/populate-entity-registry.js` reports "Found 5 core-docs" + 100% resolution rate (1289/1289 deps) - [x] All 5 markdown files appear under `entities.core-docs.*` with correct `type: docs` and parsed purposes (e.g. `component-creation-guide` purpose extracted from frontmatter). Closes the 2026-05-17 handoff's Pacote E follow-up. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * test(ids): expand SCAN_CONFIG count to 15 for new core-docs category The previous test pinned `SCAN_CONFIG.length` at 14 (10 original + 4 NOG-16A). Adding `core-docs` raises the count to 15. Test name and assertions updated accordingly. Added a type/basePath assertion for the new `core-docs` entry alongside the existing checks. Suite: 96/96 pass (was 95/95 — net unchanged in pass count because the pinning test simply changed its expectation). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes the Pacote E follow-up from the 2026-05-17 handoff. The IDS registry's
modulesscan covers.aiox-core/core/**/*.{js,mjs}only, so framework documentation under.aiox-core/core/docs/was invisible to impact analysis. Operators editing those guides got no signal inaiox graph,*idsqueries, or pre-push validation when references shifted.What changes
{ category: 'core-docs', basePath: '.aiox-core/core/docs', glob: '**/*.md', type: 'docs' }toSCAN_CONFIGinpopulate-entity-registry.js.docs: 0.5toADAPTABILITY_DEFAULTS(same numeric outcome as the fallback, but documents intent: reference material, mutable across major project evolution but rarely per-mission).Files newly visible
SHARD-TRANSLATION-GUIDE.mdcomponent-creation-guide.mdsession-update-pattern.mdtemplate-syntax.mdtroubleshooting-guide.mdValidation
npm run lint→ exit 0node .aiox-core/development/scripts/populate-entity-registry.js→ 5 core-docs found, 100% resolution rateentity-registry.yamlconfirmsentities.core-docs.*with correct purposes extracted from frontmatter / overview / title (per PR fix(ids): scope purpose inference + sync self-entry on regen #748 priority chain)Test plan
aiox graph --depsreflects the newcore-docscategoryCo-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com
Summary by CodeRabbit
New Features
Tests
Chores