Skip to content

docs: verify and migrate documentation to wiki#114

Merged
ericfitz merged 2 commits intomainfrom
docs/verify-migrate-documentation
Jan 24, 2026
Merged

docs: verify and migrate documentation to wiki#114
ericfitz merged 2 commits intomainfrom
docs/verify-migrate-documentation

Conversation

@ericfitz
Copy link
Owner

Summary

  • Created verify-migrate-doc skill for automated documentation verification and wiki migration
  • Verified 66 documentation files against source code and corrected inaccuracies
  • Migrated all verified documentation to the wiki repository
  • Moved processed files to docs/migrated/ folder

Key Corrections Made

  • OAuth provider: idp=testidp=tmi
  • Default max_active_invocations: 1 → 3
  • Default max_requests_per_minute: 100 → 1000
  • Health endpoint: /version/ (root)
  • Webhook endpoint: /webhooks/webhooks/subscriptions
  • Framework references: Echo → Gin
  • Migration system: golang-migrate → GORM AutoMigrate

Test plan

  • Verify skill can be invoked with /verify-migrate-doc <path>
  • Confirm migrated files are in docs/migrated/
  • Check wiki pages have updated content

🤖 Generated with Claude Code

ericfitz and others added 2 commits January 24, 2026 14:15
Verification found document is OUTDATED - based on legacy SQL migrations
while TMI now uses GORM AutoMigrate with api/models/models.go as source.

Key issues found and documented:
- Migration paths incorrect (now in docs/reference/legacy-migrations/)
- Schema management approach changed to GORM AutoMigrate
- Several fields/tables missing (cwe_id, cvss, alias, user_preferences)
- Make target names incorrect (reset-db-heroku not heroku-reset-db)
- threat_type is now array, not TEXT

Migrated useful design patterns to wiki Database-Schema-Reference.md:
- UUID generation via GORM BeforeCreate
- Provider-based identity scoping
- Dual foreign key pattern for authorization
- Threat modeling framework options
- Asset type enumeration

Original file moved to docs/migrated/ with verification summary.
Wiki page now serves as authoritative reference.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Verified 66 markdown files against source code
- Corrected numerous inaccuracies found during verification:
  - Updated outdated default values (quotas, rate limits)
  - Fixed wrong endpoints and provider IDs
  - Corrected migration system references (golang-migrate to GORM)
  - Fixed framework references (Echo to Gin)
- Migrated all verified content to wiki repository
- Moved original files to docs/migrated/ with verification summaries
- Added NEEDS-REVIEW markers for items requiring manual review
- Created verify-migrate-doc skill for future documentation verification

Key corrections:
- OAuth provider: idp=test -> idp=tmi
- Default max_active_invocations: 1 -> 3
- Default max_requests_per_minute: 100 -> 1000
- Health endpoint: /version -> / (root)
- Webhook endpoint: /webhooks -> /webhooks/subscriptions

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@dosubot dosubot bot added the documentation Improvements or additions to documentation label Jan 24, 2026
@ericfitz ericfitz merged commit 57b0878 into main Jan 24, 2026
7 checks passed
@ericfitz ericfitz deleted the docs/verify-migrate-documentation branch January 24, 2026 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant