Skip to content

feat: Implement steel thread directory structure (v1.2.1)#1

Merged
matthewsinclair merged 5 commits intomainfrom
feat/st-directory-structure-v1.2.1
Jul 9, 2025
Merged

feat: Implement steel thread directory structure (v1.2.1)#1
matthewsinclair merged 5 commits intomainfrom
feat/st-directory-structure-v1.2.1

Conversation

@matthewsinclair
Copy link
Copy Markdown
Owner

@matthewsinclair matthewsinclair commented Jul 9, 2025

Summary

This PR implements a major architectural change converting steel threads from single markdown files to directory structures for better organization and documentation.

Key Changes

  • New Directory Structure: Steel threads now organized as ST####/ directories instead of ST####.md files
  • Multiple Files: Each directory contains info.md, design.md, impl.md, tasks.md, results.md
  • Automatic Migration: stp upgrade handles v1.2.0 → v1.2.1 migration with backups
  • Backward Compatibility: Full version detection ensures commands work with both structures
  • Comprehensive Updates: All scripts, tests, and documentation updated

Benefits

  • Better separation of concerns between different documentation aspects
  • Easier to work with specific sections without affecting others
  • Improved git diff visibility for targeted changes
  • Supports richer documentation without file bloat

Testing

  • All tests passing (steel thread tests, upgrade tests, migration tests)
  • Successfully migrated STP's own 14 steel threads
  • Backups created in .stp_backup/1.2.1/

Migration

Run stp upgrade to automatically migrate existing projects. Original files are backed up.

Release Notes

See RELEASE_NOTES_v1.2.1.md for detailed information.

Related to: ST0014

- Steel threads are now directories containing multiple files (info.md, design.md, impl.md, tasks.md, results.md)
- Added migration script for upgrading from v1.2.0 to v1.2.1
- Updated stp_st to handle both legacy and new directory structures
- Enhanced commands to support file-specific operations
- Updated all documentation to reflect new structure
- Added comprehensive tests for directory operations and migration
Major architectural change converting steel threads from single markdown files
to directory structures containing multiple files for better organization.

Key changes:
- Steel threads now organized as ST####/ directories instead of ST####.md files
- Each directory contains: info.md, design.md, impl.md, tasks.md, results.md
- Updated stp_st script with full backward compatibility
- Created migration script (migrate_st_to_dirs) for automatic conversion
- Updated stp_upgrade to handle v1.2.0 -> v1.2.1 migration
- Fixed all tests to work with new directory structure
- Comprehensive documentation updates across all files
- Created backups of original files in .stp_backup/1.2.1/

Benefits:
- Better separation of concerns between different aspects of a steel thread
- Easier to work with specific sections without affecting others
- Supports richer documentation without file bloat
- Maintains full backward compatibility through version detection
- Marked ST0014 (Directory Structure for Steel Threads) as completed
- Added comprehensive release notes for v1.2.1
- Updated steel_threads.md index
- Added new steel thread for potential enhancements
- Documented ideas for additional file types (testing.md, metrics.md, dependencies.md)
- Outlined design decisions for template improvements
- Set as 'Not Started' for future implementation
- Modified validation to check for both .md files and directories
- Added checks for status subdirectories (COMPLETED, NOT-STARTED, CANCELLED)
- Ensures PR checks work with v1.2.1 directory structure
@matthewsinclair matthewsinclair merged commit 1fb73f6 into main Jul 9, 2025
8 of 9 checks passed
@matthewsinclair matthewsinclair deleted the feat/st-directory-structure-v1.2.1 branch July 9, 2025 19:32
matthewsinclair added a commit that referenced this pull request Apr 6, 2026
…e-v1.2.1

feat: Implement steel thread directory structure (v1.2.1)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant