Problem
Currently, the AI devkit generates documentation files in a hardcoded docs/ai/ directory. There is no way to customize this path via .ai-devkit.json configuration.
In some projects, the docs/ folder is already used for other purposes (e.g., API docs, user-facing documentation, static site generators), and having docs/ai/ mixed in can cause conflicts or confusion.
Proposed Solution
Add a docsDir (or similar) configuration option to .ai-devkit.json that allows users to specify a custom path for the generated documentation folder.
Example
{
"version": "0.16.0",
"docsDir": ".ai-docs",
"environments": ["claude"],
"phases": [
"requirements",
"design",
"planning",
"implementation",
"testing",
"deployment",
"monitoring"
]
}
This would generate phase folders under .ai-docs/ instead of the default docs/ai/.
Default Behavior
If docsDir is not specified, the current default (docs/ai) should be preserved for backward compatibility.
Use Cases
- Projects where
docs/ is reserved for user-facing documentation
- Monorepos where each package may have its own AI devkit docs
- Teams that prefer to keep AI-generated docs in a hidden directory (e.g.,
.ai-docs/)
- Projects using documentation generators (Docusaurus, VitePress, etc.) that scan
docs/
Additional Context
Current .ai-devkit.json config has no option for customizing the output directory:
{
"version": "0.16.0",
"environments": ["claude"],
"phases": ["requirements", "design", "planning", "implementation", "testing", "deployment", "monitoring"]
}
Problem
Currently, the AI devkit generates documentation files in a hardcoded
docs/ai/directory. There is no way to customize this path via.ai-devkit.jsonconfiguration.In some projects, the
docs/folder is already used for other purposes (e.g., API docs, user-facing documentation, static site generators), and havingdocs/ai/mixed in can cause conflicts or confusion.Proposed Solution
Add a
docsDir(or similar) configuration option to.ai-devkit.jsonthat allows users to specify a custom path for the generated documentation folder.Example
{ "version": "0.16.0", "docsDir": ".ai-docs", "environments": ["claude"], "phases": [ "requirements", "design", "planning", "implementation", "testing", "deployment", "monitoring" ] }This would generate phase folders under
.ai-docs/instead of the defaultdocs/ai/.Default Behavior
If
docsDiris not specified, the current default (docs/ai) should be preserved for backward compatibility.Use Cases
docs/is reserved for user-facing documentation.ai-docs/)docs/Additional Context
Current
.ai-devkit.jsonconfig has no option for customizing the output directory:{ "version": "0.16.0", "environments": ["claude"], "phases": ["requirements", "design", "planning", "implementation", "testing", "deployment", "monitoring"] }