More flexible artifacts - #37
Merged
Merged
Conversation
- Enhanced setup_project_docs tool to accept file paths in addition to template names - Added support for linking existing documentation files (README.md, ARCHITECTURE.md, etc.) - Implemented symlink creation in .vibe/docs/ folder for standard path integration - Added PathValidationUtils class for secure file path validation - Added FileDetectionManager class for pattern-based file discovery - Enhanced ProjectDocsManager with symlink creation and management - Updated tool descriptions with comprehensive examples and usage guidance - Added comprehensive integration tests (215 tests passing) - Supports mixed usage: combine templates and file paths in same setup call - Multiple document types can reference the same source file - Maintains full backward compatibility with existing template workflows BREAKING CHANGE: setup_project_docs tool parameters now accept string values instead of strict enums, but existing template names continue to work unchanged
- Added 'none' template option for architecture, requirements, and design documents
- Creates instructional placeholder documents that guide LLM to use plan file instead
- Enables granular control: users can disable specific document types while keeping others
- Cross-conversation persistence: choice survives across sessions
- Clear LLM instructions with 'DO NOT EDIT THIS FILE' guidance
- Enhanced tool descriptions with 'none' option examples and usage guidance
- Added comprehensive test coverage for 'none' template functionality (221 tests passing)
- Perfect for users who prefer plan-file-only workflows or minimal documentation overhead
Example usage:
setup_project_docs({
architecture: 'arc42', // Use template
requirements: 'none', // Disable with placeholder
design: 'README.md' // Link existing file
})
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
1 participant
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.
No description provided.