Skip to content

Conversation

@ksylvan
Copy link
Collaborator

@ksylvan ksylvan commented Jul 9, 2025

Update file paths to reflect new data directory structure

Summary

This PR updates file paths and references throughout the documentation to reflect a reorganization of the project structure. The changes primarily involve moving patterns and strategies from the root level to a data/ subdirectory, and updating the code_helper binary location from plugins/tools/ to cmd/.

Files Changed

  • README.md: Updated multiple file path references and links to reflect the new directory structure
  • data/patterns/create_coding_feature/README.md: Updated the installation command for the code_helper binary

Code Changes

README.md

  1. Logo path update: Changed the fabric logo image source from ./images/fabric-logo-gif.gif to ./docs/images/fabric-logo-gif.gif
  2. Patterns directory reference: Updated the patterns directory link from /patterns to /data/patterns
  3. Strategies directory reference: Updated the strategies directory link from /strategies to /data/strategies
  4. Create coding feature pattern link: Updated the README reference from ./patterns/create_coding_feature/README.md to ./data/patterns/create_coding_feature/README.md

data/patterns/create_coding_feature/README.md

  1. Installation command update: Changed the Go install path from github.com/danielmiessler/fabric/plugins/tools/code_helper@latest to github.com/danielmiessler/fabric/cmd/code_helper@latest

Reason for Changes

These changes appear to be part of a project restructuring effort to better organize the codebase. The modifications serve to:

  • Consolidate data-related directories (patterns, strategies) under a unified data/ directory
  • Move the code_helper binary from plugins/tools/ to the more conventional cmd/ directory
  • Update the documentation structure by moving images to a dedicated docs/ directory

Impact of Changes

  • Improved Organization: The new structure provides better separation of concerns with data files grouped together and binaries in a standard Go project layout
  • Documentation Consistency: All references now point to the correct locations, ensuring users can find the resources they need
  • No Functional Changes: These are purely organizational changes that don't affect the core functionality of the application

Test Plan

  • Verify that all updated links in the README.md file resolve correctly
  • Confirm that the code_helper binary can be installed using the new path
  • Ensure that the fabric logo displays correctly with the updated image path
  • Test that users can navigate to the patterns and strategies directories using the updated links

Additional Notes

  • These changes will require users who have bookmarked or referenced the old paths to update their references
  • The installation instructions for code_helper will need to be communicated to existing users
  • Consider adding a migration note or changelog entry to help users understand the structural changes

## CHANGES

- Move fabric logo image path to docs directory
- Update patterns directory reference to data/patterns location
- Update strategies directory reference to data/strategies location
- Fix create_coding_feature README path reference
- Update code_helper install path to cmd directory
@ksylvan ksylvan merged commit ff245ed into danielmiessler:main Jul 9, 2025
@ksylvan ksylvan deleted the 0708-fix-documentation-paths-for-restructured-repo branch July 9, 2025 15:47
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