[Medium] [Task] Documentation Inconsistency Report #291
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Documentation Inconsistency Report
After thoroughly reading all docs in the project (AGENTS.md, GAME_BRIEFING.md, project-structure.txt, dependency-graph.json, circular-deps.txt, and all spec files), the following inconsistencies were found.
🔴 Critical Inconsistencies (Contradictions)
1. Pact Persistence Through Prestige
Resolution needed: Fix the misquote in pact-system-spec.md §5.2. AGENTS.md says pacts do NOT persist. The code resetting them is correct behavior, not a discrepancy.
2.
pactBindingPrestige Upgrade DefinitionpactBindingupgrade is referenced in the store logic but is not defined inPRESTIGE_DEFconstants. This is a known gap."pactBindingupgrade — ✅ RESOLVED — Added toPRESTIGE_DEFinprestige.ts"pactBindingas one of the 14 prestige upgrades.Resolution needed: The pact-system-spec.md is outdated. The invoker-spec.md says it's resolved. Need to verify in code and update pact-system-spec.md.
3.
pactInterferenceMitigationPrestige UpgradepactInterferenceMitigation— ✅ RESOLVED — Added toPRESTIGE_DEF"pactInterferenceMitigationis NOT in the list. The listed upgrades are: manaWell, manaFlow, insightAmp, spireKey, temporalEcho, steadyHand, ancientKnowledge, elementalAttune, spellMemory, guardianPact, quickStart, elemStart, unlockedManaTypeCapacity, pactBinding.pactInterferenceMitigation.Resolution needed: Either add
pactInterferenceMitigationto the AGENTS.md and GAME_BRIEFING.md lists (making it 15 upgrades), or remove it from the code if it was added by mistake.4. Guardian Tier 2 Floor 100 Element
sand+fire+earth(composite components)sand(just the element name)sand+earth+water (radiantflames)— but radiantflames = light+fire, not sand+earth+waterlightning+fire+air (miasma)— but miasma = air+death, not lightning+fire+airResolution needed: The GAME_BRIEFING.md Tier 2 table has incorrect element-to-floor mappings for floors 100, 140, and 150. Need to verify against guardian-data.ts and correct.
5. Guardian Tier 3 Armor Values
Resolution needed: The pact times in GAME_BRIEFING.md Tier 3 (37h-44h) don't match pact-system-spec.md (19h-26h). The formula
2 + floor(floor/10)gives 19h for floor 170, not 37h. GAME_BRIEFING.md appears to have incorrect values.6. Guardian Tier 1 Pact Times
requiredTime = guardian.pactTime × (1 - pactAffinity)— but the basepactTimevalues aren't defined consistently.Resolution needed: Floor 10 pact time is 2h in GAME_BRIEFING.md but 3h in pact-system-spec.md. Need to verify in code and reconcile.
7. Guardian Tier 1 Armor Values
Resolution needed: Major discrepancy in armor values. GAME_BRIEFING.md has a clean 5% increment pattern, while pact-system-spec.md has irregular values. Need to verify in guardian-data.ts.
8. Number of Equipment Types
Resolution needed: AGENTS.md says 50, but the detailed spec and GAME_BRIEFING.md say 43. AGENTS.md needs updating.
9. Number of Disciplines
This is actually consistent — but the AGENTS.md doesn't mention the total, which could be clearer.
10. Discipline Stat Bonus Formula
StatBonus = baseValue × (XP / scalingFactor)^0.65StatBonus = baseValue × (XP / scalingFactor)^0.65✓Consistent — no issue.
🟡 Minor Inconsistencies
11. Spire Key Starting Floor Formula
startFloor = 1 + (spireKey × 2)— spireKey 0 → F1Clarification needed: The spec is clear (1 + level×2), but the briefing is ambiguous.
12. Room Type Percentages
Resolution needed: GAME_BRIEFING.md says 20% on every 7th floor, but the spec says exactly 1 room is puzzle on every 7th floor. These are different.
13. Puzzle Room Base Time
Actually consistent — no issue.
14. Puzzle Room Progress Rate
base × (1 - totalReduction)where reduction is up to 90%Clarification needed: The progress rate description in attunement-system-spec is vague (1.5-2% per tick) while the climbing spec has a detailed formula. These might be describing different things.
15. Golem Slot Formula
floor(fabricatorLevel / 2), max 5 at level 10 (+2 from Golem Crafting discipline = max 7)"Consistent — no issue.
16. Enchantment Design Time
time = 1 + 0.5 * stacks— this is per stack, not per effect slotResolution needed: AGENTS.md says "per effect slot" but the spec says "per stack". These are different if an effect has multiple stacks.
17. Prepare Stage Time
2h + 1h per 50 capacity"time = 2 + floor(equipmentCapacity / 50)— consistent ✓Consistent — no issue.
18. Apply Stage Time
2h + stackshours"time = 2 + Σ(stacks)— consistent ✓Consistent — no issue.
19. Enemy Modifiers — Mage Barrier Recharge
barrier = min(0.4, floor × 0.003); recharges 5%/tick" — consistent ✓Consistent — no issue.
20. Achievement Count
No inconsistency — just a missing detail in AGENTS.md.
🟢 Items That Are Consistent (Verified)
min(0.95, (totalHours/maxHours) × 0.95)— consistent1.5^(level-1)— consistentSummary of Action Items
pact-system-spec.md§5.2pact-system-spec.md§4.2pactBindingis marked as missing but is resolved per invoker-specAGENTS.md/GAME_BRIEFING.mdpactInterferenceMitigationto prestige upgrade list OR remove from codeGAME_BRIEFING.md§7GAME_BRIEFING.md§7GAME_BRIEFING.md§7AGENTS.mdGAME_BRIEFING.md§6AGENTS.mdGAME_BRIEFING.md§11Any time you can use a formula, do so, it keeps the game dynamic and expandable
Starting work on documentation inconsistency fixes. Will verify each claim against code and fix systematically.
All 12 documentation inconsistencies have been fixed and pushed to master (commit
e90ae82).Summary of changes:
pact-system-spec.md §5.2 — Removed fabricated misquote of AGENTS.md. The spec now correctly states that AGENTS.md says pacts do NOT persist, and the code matches this behavior.
pact-system-spec.md §4.2 — Updated stale note about
pactBindingbeing undefined. It is now properly defined inPRESTIGE_DEFwith max:5, cost:2000.pact-system-spec.md §8.2/8.3 — Corrected element tags: floor 140 is
sand+earth+water(notradiantflames), floor 150 islightning+fire+air(notmiasma), floor 200 iscrystal+stellar+void(notsoul+stellar+void).AGENTS.md + GAME_BRIEFING.md — Added
pactInterferenceMitigationto the prestige upgrade lists (now 15 upgrades total, not 14).GAME_BRIEFING.md §7 Tier 1 — Corrected armor values (10/15/18/25/20/22/25/20%) and pact times (3-10h) to match
guardian-data.ts.GAME_BRIEFING.md §7 Tier 2 — Corrected armor values (30/25/22/28/32/25/28/33%) and pact times (11-18h) to match
guardian-data.ts.GAME_BRIEFING.md §7 Tier 3 — Corrected pact times (19-26h) to match
guardian-data.tsformula2 + floor(floor/10).GAME_BRIEFING.md §7 — Corrected floor 100 element to
sand(notsand+fire+earth).AGENTS.md — Updated equipment count from "50 across 9 categories" to "43 across 8 categories".
AGENTS.md — Fixed enchantment design time from "per effect slot" to "per stack (summed across all effects)".
GAME_BRIEFING.md §6 — Clarified puzzle room frequency as "1 guaranteed room per 7th floor (seeded)" instead of "20%".
GAME_BRIEFING.md §11 — Clarified spireKey formula as
1 + level × 2.All changes verified against source code (
guardian-data.ts,prestige.ts,equipment-types-data.ts). 1009 tests passing.