Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
065fc2c
Add comprehensive expressions and operators documentation
leotorrez Feb 10, 2026
37b33c9
Expand CommandList documentation with comprehensive command reference
leotorrez Feb 10, 2026
63c33c1
Expand Resource documentation with comprehensive property reference
leotorrez Feb 10, 2026
b3c1ec2
Remove 'See Also' sections and expand Present documentation
leotorrez Feb 10, 2026
2ad4e5b
Add temp_xxmi_repo to gitignore for source code reference
leotorrez Feb 10, 2026
0929b06
Expand modifiers.md with comprehensive documentation
leotorrez Feb 10, 2026
190f7b4
Fix drawindexedinstanced = auto syntax in modifiers.md
leotorrez Feb 10, 2026
2dbafef
Clarify pre/post timing relative to Present() call and frame boundaries
leotorrez Feb 10, 2026
78817fa
Create comprehensive draw-calls.md documentation
leotorrez Feb 10, 2026
ea1ec5c
Expand custom-shader.md with comprehensive documentation
leotorrez Feb 10, 2026
da20eb9
docs: expand glossary.md with comprehensive terminology reference
leotorrez Feb 11, 2026
687a50f
docs: expand troubleshooting.md with comprehensive error documentation
leotorrez Feb 11, 2026
0033512
docs: create comprehensive debugging.md and logs.md documentation
leotorrez Feb 11, 2026
49e73e3
docs: expand operators.md with comprehensive operator reference
leotorrez Feb 11, 2026
aae95d0
docs: expand properties.md with comprehensive property reference
leotorrez Feb 11, 2026
53fa6ea
docs: expand constants.md and namespace.md with comprehensive documen…
leotorrez Feb 11, 2026
e955e91
docs: create comprehensive lifespan-of-a-frame.md documentation
leotorrez Feb 11, 2026
bc75e68
docs: create comprehensive directx-pipeline.md documentation
leotorrez Feb 11, 2026
f76a958
docs: create comprehensive shader-regex.md documentation
leotorrez Feb 11, 2026
736a908
docs: create comprehensive fuzzy-matching.md documentation
leotorrez Feb 11, 2026
94c80b4
docs: create comprehensive flags.md reference documentation
leotorrez Feb 11, 2026
1ab9f1e
docs: create comprehensive system-values.md documentation
leotorrez Feb 11, 2026
2f7ea7e
docs: create comprehensive 3dm-statics.md documentation
leotorrez Feb 11, 2026
8eca56b
docs: remove all 'See Also' sections from documentation
leotorrez Feb 12, 2026
1052e99
docs: remove remaining 'See Also' sections
leotorrez Feb 12, 2026
64e6f87
docs: merge operators.md into expressions.md to eliminate duplication
leotorrez Feb 12, 2026
5428941
docs: create comprehensive TextureOverride documentation
leotorrez Feb 12, 2026
52f4a45
docs: create comprehensive ShaderOverride documentation
leotorrez Feb 12, 2026
1a5fb37
docs: expand key.md with comprehensive Key binding documentation
leotorrez Feb 12, 2026
47ba9fc
docs: rewrite override.md as comprehensive game-agnostic overview
leotorrez Feb 12, 2026
7b875f9
docs: reorganize index.md as comprehensive landing page
leotorrez Feb 12, 2026
715e18a
docs: consolidate bind flags documentation into flags.md
leotorrez Feb 12, 2026
a2b7f8b
docs: consolidate misc flags documentation into flags.md
leotorrez Feb 12, 2026
aeda843
docs: consolidate IniParams documentation into constants.md
leotorrez Feb 12, 2026
d416899
docs: mark all consolidations as complete in REPETITION_ANALYSIS.md
leotorrez Feb 12, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
.vitepress/cache
.vitepress/dist
node_modules
package-lock.json
package-lock.jsontemp_xxmi_repo/
2 changes: 1 addition & 1 deletion .vitepress/config/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
{
text: "Logic",
items: [
{ text: "Operators", link: "operators" }, //move pre and post here
{ text: "Expressions & Operators", link: "expressions" },
{ text: "Constants", link: "constants" },
{ text: "Present", link: "present" },
{ text: "Key", link: "key" },
Expand Down
2 changes: 1 addition & 1 deletion .vitepress/config/es.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
{
text: "Logic",
items: [
{ text: 'Operators', link: 'operators' }, //move pre and post here
{ text: 'Expresiones y operadores', link: 'expressions' },
{ text: 'Constants', link: 'constants' },
{ text: 'Present', link: 'present' },
{ text: 'Key', link: 'key' },
Expand Down
2 changes: 1 addition & 1 deletion .vitepress/config/ru.ts
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
{
text: "Логика",
items: [
{ text: 'Операторы', link: 'operators' }, //move pre and post here
{ text: 'Выражения и операторы', link: 'expressions' },
{ text: 'Константы', link: 'constants' },
{ text: 'Оператор Present', link: 'present' },
{ text: 'Ключи | Key', link: 'key' },
Expand Down
2 changes: 1 addition & 1 deletion .vitepress/config/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
{
text: "Logic",
items: [
{ text: 'Operators', link: 'operators' }, //move pre and post here
{ text: 'Expressions & Operators', link: 'expressions' },
{ text: 'Constants', link: 'constants' },
{ text: 'Present', link: 'present' },
{ text: 'Key', link: 'key' },
Expand Down
269 changes: 269 additions & 0 deletions REPETITION_ANALYSIS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,269 @@
# Documentation Repetition Analysis - FINAL

This document identified areas where content was repeated or overlapped across multiple documentation files. Each entry includes severity rating and recommendations.

**Last Updated:** After Session 4 (February 12, 2026)

---

## STATUS SUMMARY

### ✅ ALL CONSOLIDATIONS COMPLETED

**Session 3:**
1. **Operators/Expressions Merge** - DONE (Commit 64e6f87)
- Merged operators.md into expressions.md
- Deleted operators.md (732 lines)
- Updated all cross-references in sidebar configs
- Eliminated ~400 lines of duplication

**Session 4:**
2. **Bind Flags Consolidation** - DONE (Commit 715e18a)
- Consolidated resource.md and fuzzy-matching.md into flags.md
- Eliminated ~120 lines of duplication
- Added clear cross-references

3. **Misc Flags Consolidation** - DONE (Commit a2b7f8b)
- Consolidated resource.md into flags.md
- Eliminated ~15 lines of duplication
- Maintained consistent formatting

4. **IniParams Consolidation** - DONE (Commit aeda843)
- Consolidated properties.md into constants.md
- Eliminated ~25 lines of duplication
- Kept quick reference in properties.md

5. **Usage Types Cross-Reference** - DONE (Commit 715e18a)
- Added cross-references in fuzzy-matching.md
- Improved clarity and navigation

### ✅ NO ACTION NEEDED
6. Frame Analysis/Hunting - Appropriate cross-referencing
7. Present Timing - Complementary perspectives
8. System Values - Appropriate use in examples
9. DXGI Formats - Brief contextual mentions
10. Glossary - Intentional quick reference

---

## COMPLETED CONSOLIDATIONS (FINAL STATUS)

## 1. ✅ OPERATORS/EXPRESSIONS MERGE - COMPLETED (Session 3)

**Action Taken:**
- Merged operators.md (732 lines) into expressions.md
- Deleted operators.md file
- Updated sidebar configurations in all language configs
- Updated cross-reference in command-list.md

**Results:**
- ✅ Eliminated ~400 lines of duplicate operator documentation
- ✅ Single source of truth: expressions.md now authoritative
- ✅ Improved clarity - no confusion about which file to reference

**Commit:** 64e6f87 - docs: merge operators.md into expressions.md to eliminate duplication

---

## 2. ✅ BIND FLAGS CONSOLIDATION - COMPLETED (Session 4)

**Affected Files:**
- `flags.md` - Complete authoritative reference (unchanged)
- `resource.md` - Simplified bind_flags section (lines 275-312)
- `fuzzy-matching.md` - Simplified flag matching section (lines 197-271)

**Action Taken:**
- Simplified resource.md bind_flags to brief list with cross-reference
- Enhanced fuzzy-matching.md with consistent structure for all flag types
- Added clear cross-references to flags.md in both files
- flags.md remains single source of truth for all DirectX 11 flags

**Results:**
- ✅ Eliminated ~120 lines of duplicate content
- ✅ Improved clarity with consistent cross-references
- ✅ flags.md is authoritative reference for all bind flags

**Commit:** 715e18a - docs: consolidate bind flags documentation into flags.md

---

## 3. ✅ MISC FLAGS CONSOLIDATION - COMPLETED (Session 4)

**Affected Files:**
- `flags.md` - Complete authoritative reference (unchanged)
- `resource.md` - Simplified misc_flags section (lines 314-342)

**Action Taken:**
- Simplified resource.md misc_flags to brief list with cross-reference
- Maintained practical examples in resource.md
- Added clear cross-reference to flags.md
- Consistent formatting with bind_flags section

**Results:**
- ✅ Eliminated ~15 lines of duplicate content
- ✅ flags.md is authoritative reference for all misc flags
- ✅ Consistent structure across resource.md flag sections

**Commit:** a2b7f8b - docs: consolidate misc flags documentation into flags.md

---

## 4. ✅ INIPARAMS CONSOLIDATION - COMPLETED (Session 4)

**Affected Files:**
- `constants.md` - Complete authoritative reference (unchanged)
- `properties.md` - Simplified IniParams section (lines 156-225)

**Action Taken:**
- Simplified properties.md IniParams to quick reference
- Kept practical examples in properties.md for quick lookup
- Added clear cross-reference to constants.md
- constants.md remains comprehensive IniParams documentation

**Results:**
- ✅ Eliminated ~25 lines of duplicate content
- ✅ constants.md is authoritative reference for IniParams
- ✅ properties.md provides useful quick reference
- ✅ Clear separation: properties.md for quick lookup, constants.md for deep dive

**Commit:** aeda843 - docs: consolidate IniParams documentation into constants.md

---

## 5. ✅ USAGE TYPES CROSS-REFERENCE - COMPLETED (Session 4)

**Affected Files:**
- `flags.md` - Complete authoritative reference (unchanged)
- `fuzzy-matching.md` - Enhanced with cross-references (part of commit 715e18a)

**Action Taken:**
- Added cross-references to flags.md in fuzzy-matching.md
- Enhanced match_usage, match_misc_flags, and match_cpu_access_flags sections
- Consistent structure for all flag-matching properties

**Results:**
- ✅ Improved clarity and navigation
- ✅ flags.md is authoritative reference for all flag types
- ✅ fuzzy-matching.md provides focused matching syntax

**Commit:** 715e18a (included in bind flags consolidation)

---

## FINAL RESULTS SUMMARY

### Total Consolidations Completed: 5

**Session 3:**
1. Operators/Expressions merge - ~400 lines eliminated

**Session 4:**
2. Bind flags consolidation - ~120 lines eliminated
3. Misc flags consolidation - ~15 lines eliminated
4. IniParams consolidation - ~25 lines eliminated
5. Usage types cross-reference - improved clarity

### Total Impact:

**Lines eliminated:** ~560 lines of duplicate content
**Files deleted:** 1 (operators.md)
**Files simplified:** 4 (resource.md, fuzzy-matching.md, properties.md, command-list.md)
**Files enhanced:** 2 (expressions.md, flags.md as authoritative references)

### Benefits Achieved:

- ✅ **Single source of truth** for all major topics:
- expressions.md → operators and expressions
- flags.md → all DirectX 11 flags
- constants.md → IniParams and variable types

- ✅ **Improved maintainability** - Update once, not 2-3 times
- ✅ **Clearer navigation** - Cross-references guide users to authoritative sources
- ✅ **Better user experience** - No confusion about which file to trust
- ✅ **Reduced maintenance burden** - Fewer places to update
- ✅ **Consistent structure** - Similar topics follow similar patterns

### Files with Authoritative Documentation:

| Topic | Authoritative Source | Supporting References |
|-------|---------------------|---------------------|
| Operators & Expressions | expressions.md | command-list.md (link) |
| Bind Flags | flags.md | resource.md, fuzzy-matching.md (cross-refs) |
| Misc Flags | flags.md | resource.md (cross-ref) |
| CPU Access Flags | flags.md | fuzzy-matching.md (cross-ref) |
| Usage Types | flags.md | fuzzy-matching.md (cross-ref) |
| IniParams | constants.md | properties.md (quick ref) |

---

## DOCUMENTATION QUALITY STATUS

### ✅ Quality Goals Achieved:

1. **No redundant documentation** - All major duplications eliminated
2. **Clear authoritative sources** - Each topic has one definitive reference
3. **Helpful cross-references** - Users guided to comprehensive documentation
4. **Consistent structure** - Similar topics follow similar patterns
5. **Maintainable** - Future updates only need to touch one file per topic

### Documentation Completion: ~95%

**Core Documentation:** ✅ Complete and consolidated
**Advanced Topics:** ✅ Complete
**Specialized Features:** ✅ Complete
**Quality Improvements:** ✅ All major consolidations complete

---

## REMAINING MINOR OVERLAPS (ACCEPTABLE)

These overlaps are **intentional and acceptable** - they serve different purposes:

### 6. Frame Analysis/Hunting
- **hunting.md** - User workflow perspective
- **frame-analysis.md** - Technical dump format
- **Status:** Appropriate cross-referencing, no action needed

### 7. Present Timing
- **present.md** - Technical execution model
- **lifespan-of-a-frame.md** - Conceptual overview
- **Status:** Complementary perspectives, no action needed

### 8. System Values
- **system-values.md** - Complete reference
- **shader-regex.md** - Brief usage examples
- **Status:** Appropriate contextual use, no action needed

### 9. DXGI Formats
- **resource.md** - Format property documentation
- **flags.md** - Brief format mentions
- **Status:** Different contexts, no action needed

### 10. Glossary
- **glossary.md** - Quick reference
- **Various files** - Detailed documentation
- **Status:** Intentional by design, no action needed

---

## CONCLUSION

All significant content duplications have been addressed. The documentation now follows a clear structure with single sources of truth for each major topic, clear cross-references, and improved maintainability.

**Status: DOCUMENTATION QUALITY CONSOLIDATION COMPLETE** ✅

---

## COMMITS SUMMARY

### Session 3:
- `64e6f87` - docs: merge operators.md into expressions.md to eliminate duplication

### Session 4:
- `715e18a` - docs: consolidate bind flags documentation into flags.md
- `a2b7f8b` - docs: consolidate misc flags documentation into flags.md
- `aeda843` - docs: consolidate IniParams documentation into constants.md

**Total: 4 consolidation commits**

---
Loading