Conversation
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
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>
Contributor
Author
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.md→docs/ADVANCED_USAGE.mdAI_DYNAMIC_TOOLS_FAQ.md→docs/AI_DYNAMIC_TOOLS_FAQ.mdCONFIGURATION.md→docs/CONFIGURATION.mdDEPLOYMENT.md→docs/DEPLOYMENT.mdDYNAMIC_TOOLS_GUIDE.md→docs/DYNAMIC_TOOLS_GUIDE.mdINTEGRATION.md→docs/INTEGRATION.mdMOD_DEVELOPMENT.md→docs/MOD_DEVELOPMENT.mdOPENAI_TOOL_NORMALIZATION.md→docs/OPENAI_TOOL_NORMALIZATION.mdSOLUTION_SUMMARY.md→docs/SOLUTION_SUMMARY.mdFiles Kept in Root Directory:
README.md(primary entry point)AGENTS.md(kept at root level for codex/AI tool discovery)Reference Updates:
README.mdto point to the newdocs/pathsAGENTS.mdin.github/copilot-instructions.mdBenefits
docs/directory alongside the existingarchitecture-flow.svgAGENTS.mdremains at root level for easy discovery by codex and other AI toolsThe
README.mdandAGENTS.mdfiles 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.