chore: backfill :proponents: for 33 anchors (#668 Phase A)#672
Conversation
:proponents: is a required attribute but was missing across the catalog. Attribute 22 anchors to their canonical originator (EN + DE) and sync 11 German files with their English source. Names only, no invented dates. Deferred (no single originator; awaiting a convention): sota, ssot-principle, devils-advocate, what-qualifies-as-a-semantic-anchor. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (10)
✅ Files skipped from review due to trivial changes (8)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughDiese PR ergänzt in zahlreichen Asciidoc-Anchor-Dateien neue ChangesMetadata Audit:
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related issues
Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 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 |
There was a problem hiding this comment.
Actionable comments posted: 7
🧹 Nitpick comments (3)
docs/anchors/heros-journey.de.adoc (1)
4-4: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win
:proponents` auf Namen reduzieren.Die bibliografischen Zusätze gehören bereits in
Schlüsselvertreter::; als Metadaten sind sie unnötig und erschweren die Konsistenz zwischen den Anchors.♻️ Vorschlag
-:proponents: Joseph Campbell ("The Hero with a Thousand Faces"), Christopher Vogler ("The Writer's Journey") +:proponents: Joseph Campbell, Christopher Vogler🤖 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 `@docs/anchors/heros-journey.de.adoc` at line 4, The :proponents: anchor value currently includes bibliographic titles, which should be removed to keep metadata consistent. Update the :proponents: definition in heros-journey.de.adoc to contain only the names, and leave the bibliographic references under Schlüsselvertreter:: where they already belong.docs/anchors/fichtean-curve.de.adoc (1)
4-4: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win
:proponents` auf Namen normalisieren.Die bibliografischen Zusätze machen das Metadatenfeld unnötig uneinheitlich; im Audit werden kanonische Namen erwartet. Bitte die Werkstitel im Fließtext lassen.
♻️ Vorschlag
-:proponents: John Gardner ("The Art of Fiction"), Janet Burroway ("Writing Fiction") +:proponents: John Gardner, Janet Burroway🤖 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 `@docs/anchors/fichtean-curve.de.adoc` at line 4, The proponents metadata value is using bibliographic qualifiers instead of canonical names, so normalize the :proponents field in fichtean-curve.de.adoc to contain only the person names and keep the work titles in the prose text. Update the metadata entry near the existing :proponents: declaration so it lists just John Gardner and Janet Burroway, and leave the quoted book titles out of that field.docs/anchors/five-whys.de.adoc (1)
4-4: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win
:proponents` auf reine Namen normalisieren.Der Zusatz
(Toyota)ist für das Metadatenfeld nicht nötig und macht die Einträge inkonsistenter als die übrigen Anchors.♻️ Vorschlag
-:proponents: Sakichi Toyoda, Taiichi Ohno (Toyota) +:proponents: Sakichi Toyoda, Taiichi Ohno🤖 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 `@docs/anchors/five-whys.de.adoc` at line 4, The proponents metadata in the five-whys.de.adoc anchor should be normalized to plain names only. Update the :proponents: entry in this document to remove the extra “(Toyota)” text so it matches the naming style used by the other anchors and keeps metadata consistent.
🤖 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.
Inline comments:
In `@docs/anchors/freytags-pyramid.de.adoc`:
- Line 4: The proponents metadata value currently mixes names, a work title, and
a year, and the embedded comma can break extraction. Update the `:proponents:`
attribute in `freytags-pyramid.de.adoc` to contain only the names, keeping it as
a simple comma-separated list of people such as Gustav Freytag and John Yorke,
and remove the book title/year details from that field.
In `@docs/anchors/kishotenketsu.de.adoc`:
- Line 4: The :proponents: metadata value is mixing an umbrella tradition, a
person, and a parenthetical qualifier, so normalize it to clear, individually
attributable names in kishotenketsu.de.adoc. Update the :proponents: entry to
use consistent, comma-separated contributor names or categories only, and remove
the mixed phrasing so the metadata stays precise and easy to map.
In `@docs/anchors/property-based-testing.adoc`:
- Line 4: The :proponents: metadata contains an extra parenthetical qualifier
that turns the value into more than a plain list of names. Update the
property-based testing anchor metadata so the :proponents: field in the document
contains only the two author names, using the existing anchor entry as the place
to make the change, and remove the QuickCheck text entirely.
In `@docs/anchors/property-based-testing.de.adoc`:
- Line 4: The :proponents: attribute in property-based-testing.de.adoc still
includes the “(QuickCheck)” suffix, but it should contain only the two author
names. Update the :proponents: value so it references just Koen Claessen and
John Hughes, and remove the QuickCheck text to keep the extracted canonical
metadata name-only.
In `@docs/anchors/save-the-cat.de.adoc`:
- Line 4: The proponents metadata value should be reduced to the person’s name
only, because the current value in the save-the-cat anchor includes the book
title and violates the “names only” convention. Update the :proponents: entry in
the anchor metadata to keep only Blake Snyder, using the existing metadata key
and preserving the rest of the document unchanged.
In `@docs/anchors/story-circle-dan-harmon.de.adoc`:
- Line 4: The :proponents: metadata value is being split incorrectly by
extract-metadata.js because the entry contains a comma inside the parenthetical
text. Update the proponents value in the story-circle-dan-harmon document so it
no longer contains an internal comma, using a wording that still identifies Dan
Harmon without triggering the comma-based parser, and keep the change confined
to the :proponents: field.
In `@docs/anchors/three-act-structure.de.adoc`:
- Line 4: The :proponents: metadata in the three-act-structure document still
includes worked-title/source parentheticals, which should be removed so only
names remain. Update the :proponents: attribute value in the relevant AsciiDoc
entry to list just the person names, and keep the format consistent with the
rest of the metadata.
---
Nitpick comments:
In `@docs/anchors/fichtean-curve.de.adoc`:
- Line 4: The proponents metadata value is using bibliographic qualifiers
instead of canonical names, so normalize the :proponents field in
fichtean-curve.de.adoc to contain only the person names and keep the work titles
in the prose text. Update the metadata entry near the existing :proponents:
declaration so it lists just John Gardner and Janet Burroway, and leave the
quoted book titles out of that field.
In `@docs/anchors/five-whys.de.adoc`:
- Line 4: The proponents metadata in the five-whys.de.adoc anchor should be
normalized to plain names only. Update the :proponents: entry in this document
to remove the extra “(Toyota)” text so it matches the naming style used by the
other anchors and keeps metadata consistent.
In `@docs/anchors/heros-journey.de.adoc`:
- Line 4: The :proponents: anchor value currently includes bibliographic titles,
which should be removed to keep metadata consistent. Update the :proponents:
definition in heros-journey.de.adoc to contain only the names, and leave the
bibliographic references under Schlüsselvertreter:: where they already belong.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: 24570f14-50e3-4b3e-b3e9-62ba7a5333bd
📒 Files selected for processing (56)
docs/anchors/adr-according-to-nygard.adocdocs/anchors/adr-according-to-nygard.de.adocdocs/anchors/c4-diagrams.adocdocs/anchors/c4-diagrams.de.adocdocs/anchors/clean-architecture.adocdocs/anchors/clean-architecture.de.adocdocs/anchors/control-chart-shewhart.adocdocs/anchors/control-chart-shewhart.de.adocdocs/anchors/diataxis-framework.adocdocs/anchors/diataxis-framework.de.adocdocs/anchors/docs-as-code.adocdocs/anchors/docs-as-code.de.adocdocs/anchors/domain-driven-design.adocdocs/anchors/domain-driven-design.de.adocdocs/anchors/ears-requirements.adocdocs/anchors/ears-requirements.de.adocdocs/anchors/feynman-technique.adocdocs/anchors/feynman-technique.de.adocdocs/anchors/fichtean-curve.de.adocdocs/anchors/five-whys.adocdocs/anchors/five-whys.de.adocdocs/anchors/freytags-pyramid.de.adocdocs/anchors/heros-journey.de.adocdocs/anchors/hexagonal-architecture.adocdocs/anchors/hexagonal-architecture.de.adocdocs/anchors/impact-mapping.adocdocs/anchors/impact-mapping.de.adocdocs/anchors/kishotenketsu.de.adocdocs/anchors/mece.adocdocs/anchors/mece.de.adocdocs/anchors/mental-model-according-to-naur.de.adocdocs/anchors/nelson-rules.adocdocs/anchors/nelson-rules.de.adocdocs/anchors/problem-space-nvc.de.adocdocs/anchors/property-based-testing.adocdocs/anchors/property-based-testing.de.adocdocs/anchors/pugh-matrix.adocdocs/anchors/pugh-matrix.de.adocdocs/anchors/pyramid-principle.adocdocs/anchors/pyramid-principle.de.adocdocs/anchors/save-the-cat.de.adocdocs/anchors/semantic-versioning.adocdocs/anchors/semantic-versioning.de.adocdocs/anchors/socratic-method.de.adocdocs/anchors/solid-principles.de.adocdocs/anchors/story-circle-dan-harmon.de.adocdocs/anchors/testing-pyramid.adocdocs/anchors/testing-pyramid.de.adocdocs/anchors/three-act-structure.de.adocdocs/anchors/timtowtdi.adocdocs/anchors/timtowtdi.de.adocdocs/anchors/user-story-mapping.adocdocs/anchors/user-story-mapping.de.adocdocs/anchors/wardley-mapping.adocdocs/anchors/wardley-mapping.de.adocdocs/changelog.adoc
| = Freytag's Pyramid | ||
| :categories: creative-writing | ||
| :roles: technical-writer, educator, consultant | ||
| :proponents: Gustav Freytag ("Die Technik des Dramas", 1863), John Yorke ("Into the Woods") |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
:proponents` auf Namen reduzieren.
Der aktuelle Wert mischt Namen, Werkstitel und eine Jahreszahl; das macht die Metadaten unnötig fragil, und das innere Komma kann eine kommagetrennte Extraktion beschädigen.
♻️ Vorschlag
-:proponents: Gustav Freytag ("Die Technik des Dramas", 1863), John Yorke ("Into the Woods")
+:proponents: Gustav Freytag, John Yorke📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| :proponents: Gustav Freytag ("Die Technik des Dramas", 1863), John Yorke ("Into the Woods") | |
| :proponents: Gustav Freytag, John Yorke |
🤖 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 `@docs/anchors/freytags-pyramid.de.adoc` at line 4, The proponents metadata
value currently mixes names, a work title, and a year, and the embedded comma
can break extraction. Update the `:proponents:` attribute in
`freytags-pyramid.de.adoc` to contain only the names, keeping it as a simple
comma-separated list of people such as Gustav Freytag and John Yorke, and remove
the book title/year details from that field.
| = Kishōtenketsu | ||
| :categories: creative-writing | ||
| :roles: technical-writer, educator, consultant | ||
| :proponents: Traditional Chinese and Japanese narrative tradition; Tzvetan Todorov (structural analysis) |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
:proponents:` auf klar zuordenbare Namen normalisieren.
Der aktuelle Wert mischt eine Tradition, eine Person und einen Klammerzusatz. Das ist für die Metadaten uneinheitlich und erschwert die Zuordnung; falls mehrere Einträge gewollt sind, bitte als saubere, komma-separierte Namen modellieren.
As per path instructions, :proponents: soll präzise, reichhaltig, konsistent und zuordenbar bleiben.
💡 Möglicher Fix
-:proponents: Traditional Chinese and Japanese narrative tradition; Tzvetan Todorov (structural analysis)
+:proponents: Tzvetan Todorov📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| :proponents: Traditional Chinese and Japanese narrative tradition; Tzvetan Todorov (structural analysis) | |
| :proponents: Tzvetan Todorov |
🤖 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 `@docs/anchors/kishotenketsu.de.adoc` at line 4, The :proponents: metadata
value is mixing an umbrella tradition, a person, and a parenthetical qualifier,
so normalize it to clear, individually attributable names in
kishotenketsu.de.adoc. Update the :proponents: entry to use consistent,
comma-separated contributor names or categories only, and remove the mixed
phrasing so the metadata stays precise and easy to map.
Source: Path instructions
| = Property-Based Testing | ||
| :categories: testing-quality | ||
| :roles: software-developer, qa-engineer | ||
| :proponents: Koen Claessen, John Hughes (QuickCheck) |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Klammerzusatz im :proponents:-Feld entfernen.
QuickCheck ist kein Personenname und macht das Feld damit nicht mehr zu einer reinen Namensliste. Bitte auf Koen Claessen, John Hughes kürzen, damit es zur Audit-Vorgabe passt.
♻️ Vorschlag
-:proponents: Koen Claessen, John Hughes (QuickCheck)
+:proponents: Koen Claessen, John Hughes📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| :proponents: Koen Claessen, John Hughes (QuickCheck) | |
| :proponents: Koen Claessen, John Hughes |
🤖 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 `@docs/anchors/property-based-testing.adoc` at line 4, The :proponents:
metadata contains an extra parenthetical qualifier that turns the value into
more than a plain list of names. Update the property-based testing anchor
metadata so the :proponents: field in the document contains only the two author
names, using the existing anchor entry as the place to make the change, and
remove the QuickCheck text entirely.
| = Property-Based Testing | ||
| :categories: testing-quality | ||
| :roles: software-developer, qa-engineer | ||
| :proponents: Koen Claessen, John Hughes (QuickCheck) |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win
QuickCheck aus :proponents: entfernen.
Das Attribut sollte hier nur die beiden Urhebernamen enthalten; der Klammerzusatz landet sonst als Teil der kanonischen Metadaten im extrahierten Katalog. Gemäß PR-Ziel sollen die :proponents:-Werte nur Namen enthalten.
Vorgeschlagene Korrektur
-:proponents: Koen Claessen, John Hughes (QuickCheck)
+:proponents: Koen Claessen, John Hughes📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| :proponents: Koen Claessen, John Hughes (QuickCheck) | |
| :proponents: Koen Claessen, John Hughes |
🤖 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 `@docs/anchors/property-based-testing.de.adoc` at line 4, The :proponents:
attribute in property-based-testing.de.adoc still includes the “(QuickCheck)”
suffix, but it should contain only the two author names. Update the :proponents:
value so it references just Koen Claessen and John Hughes, and remove the
QuickCheck text to keep the extracted canonical metadata name-only.
| = Save the Cat! (15-Beat-Sheet) | ||
| :categories: creative-writing | ||
| :roles: technical-writer, educator, consultant | ||
| :proponents: Blake Snyder ("Save the Cat! The Last Book on Screenwriting You'll Ever Need") |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
proponents auf den Namen kürzen.
Die PR-Vorgabe lautet hier „names only“; der Buchtitel gehört nicht in die Metadaten und macht den Wert unnötig inkonsistent.
Vorschlag
-:proponents: Blake Snyder ("Save the Cat! The Last Book on Screenwriting You'll Ever Need")
+:proponents: Blake Snyder📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| :proponents: Blake Snyder ("Save the Cat! The Last Book on Screenwriting You'll Ever Need") | |
| :proponents: Blake Snyder |
🤖 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 `@docs/anchors/save-the-cat.de.adoc` at line 4, The proponents metadata value
should be reduced to the person’s name only, because the current value in the
save-the-cat anchor includes the book title and violates the “names only”
convention. Update the :proponents: entry in the anchor metadata to keep only
Blake Snyder, using the existing metadata key and preserving the rest of the
document unchanged.
| = Story Circle (Dan Harmon) | ||
| :categories: creative-writing | ||
| :roles: technical-writer, educator, consultant | ||
| :proponents: Dan Harmon (Community, Rick and Morty) |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
Komma aus dem Proponentenwert entfernen.
extract-metadata.js zerlegt :proponents: per Komma. Mit Dan Harmon (Community, Rick and Morty) landet der Wert als zwei Einträge im Export und die Metadaten werden falsch.
Vorschlag
-:proponents: Dan Harmon (Community, Rick and Morty)
+:proponents: Dan Harmon📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| :proponents: Dan Harmon (Community, Rick and Morty) | |
| :proponents: Dan Harmon |
🤖 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 `@docs/anchors/story-circle-dan-harmon.de.adoc` at line 4, The :proponents:
metadata value is being split incorrectly by extract-metadata.js because the
entry contains a comma inside the parenthetical text. Update the proponents
value in the story-circle-dan-harmon document so it no longer contains an
internal comma, using a wording that still identifies Dan Harmon without
triggering the comma-based parser, and keep the change confined to the
:proponents: field.
| = Three-Act Structure | ||
| :categories: creative-writing | ||
| :roles: technical-writer, educator, consultant | ||
| :proponents: Aristotle ("Poetics"), Syd Field ("Screenplay"), Robert McKee ("Story") |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Werktitel aus :proponents: entfernen.
Hier sollen laut PR nur Namen stehen; die Klammerzusätze machen den Metadatenwert unnötig uneinheitlich.
Vorschlag
-:proponents: Aristotle ("Poetics"), Syd Field ("Screenplay"), Robert McKee ("Story")
+:proponents: Aristotle, Syd Field, Robert McKee📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| :proponents: Aristotle ("Poetics"), Syd Field ("Screenplay"), Robert McKee ("Story") | |
| :proponents: Aristotle, Syd Field, Robert McKee |
🤖 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 `@docs/anchors/three-act-structure.de.adoc` at line 4, The :proponents:
metadata in the three-act-structure document still includes worked-title/source
parentheticals, which should be removed so only names remain. Update the
:proponents: attribute value in the relevant AsciiDoc entry to list just the
person names, and keep the format consistent with the rest of the metadata.
) Attribute the two that have an origin (devils-advocate -> Roman Catholic Church advocatus diaboli; the meta-anchor what-qualifies-as-a-semantic-anchor -> the project). Use a documented 'Community' sentinel for the two genuine terms of art with no single originator (sota, ssot-principle). Document the sentinel + the 'missing proponent is a signal' rule in CONTRIBUTING. Every anchor now carries :proponents: (185/185). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Updated: the four deferred anchors are now resolved, so this completes Phase A at 185/185 (100%).
Phases B ( |
Phase A of #668 (metadata audit).
:proponents:is a required attribute (CONTRIBUTING §178–184) but was missing across the catalog.What this does
:proponents:already present in their English source (drift fix).After this, 181 / 185 anchors carry
:proponents:.Deliberately deferred (per the analysis on #668)
Four anchors have no single originator, where a required field would invite a fabricated attribution:
sota,ssot-principle,devils-advocate, and the meta-anchorwhat-qualifies-as-a-semantic-anchor. These wait on a "no single proponent" convention (omit vs. an explicitCommunity/—sentinel — maintainer's call).Not included
public/data/*.json— regenerated by the build, not committed (matches existing convention).:tags:, 90 files) and C (:related:, 148 files) — follow-up PRs; both are partly automatable (machine-proposed → human-confirmed).:proponents:— best added after the deferred four are resolved, so it doesn't fail on them.🤖 Generated with Claude Code
Summary by CodeRabbit