Phase C: Final cleanup and documentation

[DaveSkender]

Objective

Complete remaining file organization, special cases, and comprehensive documentation updates (Plan Phases 5-8).

Scope

Indicator file organization (Phase 5):

• Audit all indicator directories for compliance
• Standardize interface files
• Split remaining multi-type .Models.cs files
• Run indicator-specific test suites

Catalog and schema (Phase 6):

• Review catalog directory structure
• Verify schema file naming
• Run catalog-related tests

Special cases and edge cases (Phase 7):

• Review remaining multi-type files
• Review partial classes spanning multiple functional areas
• Review obsolete code organization
• Update build and tooling configurations

Documentation and finalization (Phase 8):

• Update contributor documentation
• Update API documentation
• Update build and CI/CD documentation
• Create migration notes for external developers
• Final comprehensive validation

Preconditions

REQUIRED before starting:

1. ✅ Phase A completed and merged (Phase A: Directory reorganization and static class alignment #1811)
2. ✅ Phase B completed and merged (Phase B: Class and file renaming for indicators #1812)
3. ✅ All Phase A and B validation criteria passing
4. ✅ Community feedback addressed on Phase B changes

Recommended:

• Wait 1-2 weeks after Phase B for community feedback
• Ensure no critical issues reported from Phase B
• Coordinate with documentation team for site updates

Implementation Steps

1. Create feature branch from latest v3 (after Phases A-B merged)
2. Indicator organization (Phase 5 tasks 5.1-5.4)
3. Catalog cleanup (Phase 6 tasks 6.1-6.3)
4. Special cases (Phase 7 tasks 7.1-7.4)
5. Documentation (Phase 8 tasks 8.1-8.5):
   • Update contributor documentation
   • Update API documentation
   • Update build/CI documentation
   • Create external migration notes
   • Run final comprehensive validation

Validation Criteria

Must pass ALL before merging:

• Build and tests

  • Zero build warnings (Debug + Release)
  • 100% test pass rate (unit + integration + regression)
  • Performance benchmarks baseline or better

• File organization

  • All indicators follow naming conventions
  • All interfaces properly named
  • No remaining multi-type violations
  • Catalog structure verified

• Code quality

  • dotnet format --verify-no-changes passes
  • Roslynator analysis clean
  • Markdownlint passes on all docs

• Documentation

  • Contributor guide updated
  • API docs regenerated and accurate
  • Build scripts documented
  • Migration guide complete for external devs
  • Changelog entries complete

• Final validation

  • Complete test suite passes
  • Performance benchmarks run and baselined
  • Documentation site builds
  • Example projects compile and run
  • Manual smoke testing completed

Estimated Effort

Time: 14-21 hours

• Phase 5 (Indicator organization): 4-6 hours
• Phase 6 (Catalog): 2-3 hours
• Phase 7 (Special cases): 2-3 hours
• Phase 8 (Documentation): 6-9 hours

Risk: Low-Medium

• Smaller change set than Phase B
• Mostly cleanup and documentation
• Lower merge conflict risk

Success Metrics

• All indicators follow naming conventions
• All special cases documented or resolved
• Complete documentation coverage
• Migration guide helps external developers
• Zero regressions in functionality or performance

Deliverables

1. Code organization: All files follow naming conventions
2. Documentation: Complete and accurate contributor/API docs
3. Migration guide: Clear guidance for external developers
4. Changelog: Comprehensive list of changes
5. Validation report: Evidence all criteria met

Related

• Parent: File reorganization for .NET naming conventions #1810
• Prerequisites: Phase A: Directory reorganization and static class alignment #1811 (Phase A), Phase B: Class and file renaming for indicators #1812 (Phase B)
• Plan: docs/plans/file-reorg.plan.md (Phases 5-8)