Skip to content

docs: add extraction domain terminology to glossary - #52

Merged
NTCoding merged 1 commit into
mainfrom
issue-34-m1-d1-2-add-extraction-domain-
Jan 5, 2026
Merged

docs: add extraction domain terminology to glossary#52
NTCoding merged 1 commit into
mainfrom
issue-34-m1-d1-2-add-extraction-domain-

Conversation

@NTCoding

@NTCoding NTCoding commented Jan 5, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Owner

Summary

  • Add Extraction Config term defining YAML/JSON detection rules
  • Add Detection Predicate term for component identification conditions
  • Add Convention term for code patterns marking components
  • Add Enforcement term for mechanisms ensuring convention adherence

Closes #34

Test plan

  • All 4 terms added to glossary with clear definitions
  • Definitions align with PRD usage
  • YAML is valid
  • All tests pass

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Four new architectural terminology entries added to the glossary: Extraction Config (configuration describing how architectural components are detected and organized), Detection Predicate (conditions for identifying components during extraction), Convention (patterns for marking components in code), and Enforcement (mechanisms ensuring code compliance with architectural conventions).

✏️ Tip: You can customize this high-level summary in your review settings.

@NTCoding @claude
docs: add extraction domain terminology to glossary
efac567 
Add core extraction concepts to domain glossary:
- Extraction Config: YAML/JSON detection rules
- Detection Predicate: Component identification conditions
- Convention: Code patterns for marking components
- Enforcement: Mechanisms ensuring convention adherence

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@coderabbitai

coderabbitai Bot commented Jan 5, 2026 •
edited
Loading

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Four new domain terminology entries are added to the architecture glossary for extraction-related concepts: Extraction Config, Detection Predicate, Convention, and Enforcement. These terms define configuration structures, detection conditions, code marking patterns, and compliance mechanisms used in architectural component identification.

Changes

Cohort / File(s) Summary
Glossary terminology expansion
docs/architecture/domain-terminology/contextive/definitions.glossary.yml		 Added 4 new terms with definitions: Extraction Config (YAML/JSON configuration for component detection), Detection Predicate (conditional rules to identify components), Convention (patterns for marking components in code), and Enforcement (mechanisms ensuring code compliance with conventions).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

Four new terms hop into our glossary so bright, 🐰
Extraction, predicates, conventions take flight,
With enforcement as guardian, keeping things right,
Our architecture now speaks with clarity's light! ✨

Pre-merge checks

✅ 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 'docs: add extraction domain terminology to glossary' accurately and clearly summarizes the main change: adding extraction-related terms to the glossary documentation.
Linked Issues check ✅ Passed All four required terms (Extraction Config, Detection Predicate, Convention, Enforcement) have been added to the glossary with clear definitions that align with the PRD usage requirements from issue #34.
Out of Scope Changes check ✅ Passed All changes are directly scoped to issue #34: adding four extraction domain terminology terms to the glossary file. No unrelated modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0a77090 and efac567.

📒 Files selected for processing (1)
  • docs/architecture/domain-terminology/contextive/definitions.glossary.yml
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings 
Learnt from: CR
Repo: NTCoding/living-architecture PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-01-04T18:35:42.314Z
Learning: Add new domain terms to `docs/architecture/domain-terminology/contextive/definitions.glossary.yml` when discussing domain concepts

Learnt from: CR
Repo: NTCoding/living-architecture PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-01-04T18:35:42.314Z
Learning: Use domain terminology from `docs/architecture/domain-terminology/contextive/definitions.glossary.yml`. Do not invent new terms or use technical jargon when domain terminology exists.
📚 Learning: 2026-01-04T18:35:42.314Z 
Learnt from: CR
Repo: NTCoding/living-architecture PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-01-04T18:35:42.314Z
Learning: Add new domain terms to `docs/architecture/domain-terminology/contextive/definitions.glossary.yml` when discussing domain concepts

Applied to files:

  • docs/architecture/domain-terminology/contextive/definitions.glossary.yml
📚 Learning: 2026-01-04T18:35:42.314Z 
Learnt from: CR
Repo: NTCoding/living-architecture PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-01-04T18:35:42.314Z
Learning: Use domain terminology from `docs/architecture/domain-terminology/contextive/definitions.glossary.yml`. Do not invent new terms or use technical jargon when domain terminology exists.

Applied to files:

  • docs/architecture/domain-terminology/contextive/definitions.glossary.yml
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (2)
docs/architecture/domain-terminology/contextive/definitions.glossary.yml (2)

52-53: LGTM! Section organization is clear and consistent.

The blank line and section comment properly separate the new extraction concepts from the component types section, following the established pattern in the glossary.

54-64: Excellent additions! All requirements met.

The four new glossary terms successfully capture the extraction domain concepts:

  • Extraction Config: Clear definition covering YAML/JSON structure, module organization, and JSON Schema validation
  • Detection Predicate: Well-defined with concrete examples and composition logic
  • Convention: Captures code marking patterns with relevant examples
  • Enforcement: Defines compliance mechanisms with practical examples

All definitions are:
✅ Clear and concise (consistent with existing glossary style)
✅ Aligned with PR objectives and issue #34 requirements
✅ Properly structured YAML
✅ Appropriately detailed with helpful examples

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

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jan 5, 2026

Copy link
Copy Markdown

Deploying living-architecture with  Cloudflare Pages  Cloudflare Pages

Latest commit: efac567
Status: ✅  Deploy successful!
Preview URL: https://911b1f04.living-architecture.pages.dev
Branch Preview URL: https://issue-34-m1-d1-2-add-extract.living-architecture.pages.dev

View logs

@sonarqubecloud

sonarqubecloud Bot commented Jan 5, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@NTCoding NTCoding changed the title [M1-D1.2] Add extraction domain terminology to glossary docs: add extraction domain terminology to glossary Jan 5, 2026
@NTCoding
NTCoding merged commit b4ed119 into main Jan 5, 2026
9 of 10 checks passed
This was referenced Jan 8, 2026
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

See More

Successfully merging this pull request may close these issues.

[M1-D1.2] Add extraction domain terminology to glossary

1 participant

@NTCoding