Skip to content

Organize documentation files: move most .md files to docs directory, keep AGENTS.md in root#37

Merged
pardeike merged 3 commits intomainfrom
copilot/fix-c26d610c-338d-4649-a2a4-eb2a03eea15c
Sep 14, 2025
Merged

Organize documentation files: move most .md files to docs directory, keep AGENTS.md in root#37
pardeike merged 3 commits intomainfrom
copilot/fix-c26d610c-338d-4649-a2a4-eb2a03eea15c

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Sep 14, 2025

This PR reorganizes the repository structure by moving most markdown documentation files from the root directory to the existing docs/ directory, creating a cleaner and more organized project layout while keeping essential files accessible to AI tools.

Changes Made

Files Moved to docs/ directory:

  • ADVANCED_USAGE.mddocs/ADVANCED_USAGE.md
  • AI_DYNAMIC_TOOLS_FAQ.mddocs/AI_DYNAMIC_TOOLS_FAQ.md
  • CONFIGURATION.mddocs/CONFIGURATION.md
  • DEPLOYMENT.mddocs/DEPLOYMENT.md
  • DYNAMIC_TOOLS_GUIDE.mddocs/DYNAMIC_TOOLS_GUIDE.md
  • INTEGRATION.mddocs/INTEGRATION.md
  • MOD_DEVELOPMENT.mddocs/MOD_DEVELOPMENT.md
  • OPENAI_TOOL_NORMALIZATION.mddocs/OPENAI_TOOL_NORMALIZATION.md
  • SOLUTION_SUMMARY.mddocs/SOLUTION_SUMMARY.md

Files Kept in Root Directory:

  • README.md (primary entry point)
  • AGENTS.md (kept at root level for codex/AI tool discovery)

Reference Updates:

  • Updated all documentation links in README.md to point to the new docs/ paths
  • Updated the reference to AGENTS.md in .github/copilot-instructions.md

Benefits

  • Cleaner root directory: Reduces clutter in the repository root while keeping essential files accessible
  • Better organization: Most documentation is now centralized in the docs/ directory alongside the existing architecture-flow.svg
  • AI tool compatibility: AGENTS.md remains at root level for easy discovery by codex and other AI tools
  • Maintained functionality: All links have been updated to preserve navigation
  • No breaking changes: The project builds and tests continue to pass without issues

The README.md and AGENTS.md files remain in the root directory as primary entry points, while all other supporting documentation is properly organized in the dedicated documentation directory.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: pardeike <853584+pardeike@users.noreply.github.com>
Copilot AI changed the title [WIP] move all .md files except the README to a single directory (call it accordingly). Organize documentation files: move all .md files except README to docs directory Sep 14, 2025
Copilot AI requested a review from pardeike September 14, 2025 15:54
@pardeike
Copy link
Copy Markdown
Owner

@copilot Put the AGENTS.md file back, I think it should be top level so codex can find it there

Co-authored-by: pardeike <853584+pardeike@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Sep 14, 2025

@copilot Put the AGENTS.md file back, I think it should be top level so codex can find it there

Done! Moved AGENTS.md back to the root directory so codex can find it there. Also updated the reference in .github/copilot-instructions.md to point to the root location. (commit 1597efd)

Copilot AI changed the title Organize documentation files: move all .md files except README to docs directory Organize documentation files: move most .md files to docs directory, keep AGENTS.md in root Sep 14, 2025
@pardeike pardeike marked this pull request as ready for review September 14, 2025 16:15
@pardeike pardeike merged commit 236ce5e into main Sep 14, 2025
1 check passed
@pardeike pardeike deleted the copilot/fix-c26d610c-338d-4649-a2a4-eb2a03eea15c branch September 14, 2025 16:15
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.

2 participants