Problem
Documentation markdown files (e.g., api_docs.md, api_doc.md, COUPON_SYSTEM_DOCUMENTATION.md) are located directly inside Java packages under src/main/java/com/xtraction/api/. This violates Maven conventions, clutters the package structure, and pollutes search results in IDEs.
Proposed Solution
Move all markdown documentation files out of the Java source tree and place them in the project's root /api_docs/ folder, structured by feature module name.
User Stories
- As a writer/developer, I want documentation files organized together in a dedicated root directory, rather than buried deep inside Java source folders.
Acceptance Criteria
Tasks
Problem
Documentation markdown files (e.g.,
api_docs.md,api_doc.md,COUPON_SYSTEM_DOCUMENTATION.md) are located directly inside Java packages undersrc/main/java/com/xtraction/api/. This violates Maven conventions, clutters the package structure, and pollutes search results in IDEs.Proposed Solution
Move all markdown documentation files out of the Java source tree and place them in the project's root
/api_docs/folder, structured by feature module name.User Stories
Acceptance Criteria
.mdfiles remain insidesrc/main/java/./api_docs/at the repository root.Tasks
.mdfiles undersrc/main/java/./api_docs/folder.