Skip to content

Update Documentation for CSV Registry #157

@undead2146

Description

@undead2146

Description

Update project documentation to include CSV registry generation procedures, maintenance, and usage guidelines.

Requirements

• Document CSV generation process and tools
• Add maintenance procedures for registry updates
• Include troubleshooting guide for CSV issues
• Update README with registry information
• Document index.json metadata system (primary discovery) and config fallback
• Document new cross-cutting features:

Cross-Cutting Sub-Issues (EPIC #108)

Generation Process

Step-by-Step CSV Generation:

  1. Run GenHub.Tools.CsvGenerator as described in Create CSV Generation Utility #154:

    GenHub.Tools.CsvGenerator.exe --installDir "C:\Games\Command & Conquer Generals" --gameType Generals --version 1.08 --output Generals-1.08.csv --language en
  2. Commit generated CSV to docs/GameInstallationFilesRegistry/

  3. Update index.json with new metadata and checksums

  4. Test CSVDiscoverer can load and parse the new registry

  5. Update documentation with any new procedures

Maintainer Responsibilities

Who Regenerates CSVs:

  • Registry generation is performed by developers (manual tool execution)
  • Typically run when game data changes (new version, patch, or language pack release)
  • Requires access to clean game installations for scanning

When to Regenerate:

  • New game version released (e.g., Generals 1.09)
  • New language pack added
  • Significant game patch that changes file hashes
  • Quarterly maintenance to ensure accuracy

Troubleshooting Cases

Common Issues to Document:

  • File count mismatch: index.json fileCount doesn't match actual CSV lines
  • CSV not accessible: Check GitHub branch and path in raw content URL
  • Incorrect relative paths: Extra slashes, wrong casing, or absolute paths in CSV
  • Checksum validation fails: CSV file corrupted or modified after generation
  • Language detection errors: Unsupported language codes or missing language files
  • Game type misclassification: Files incorrectly categorized as Generals vs Zero Hour
  • GitHub raw URL returns 404: Branch not merged yet or incorrect repository path
  • CSV paths are absolute instead of relative: Generator not using relative paths from installation root

Acceptance Criteria

  • README updated with CSV registry information
  • Documentation includes generation procedures
  • Maintenance guide for registry updates
  • Troubleshooting section for common issues
  • Index.json system documented
  • Links to GitHub raw content URLs included

Technical Details

  • Files to Update: README.md, docs/onboarding.md
  • New Files: docs/csv-registry-maintenance.md
  • Content: Generation process, maintenance, troubleshooting

Implementation Steps

  1. Update README with registry overview
  2. Create maintenance documentation
  3. Add troubleshooting guide
  4. Document index.json system
  5. Include usage examples

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationIs documentation or complementary resource

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions