Changed module name and updated documentation #21
Conversation
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
Provide up-to-date documentation that reflects the current state of the codebase. The new README in the repository root offers a clearer overview, installation steps, environment setup, core concepts (modules, metadata, annotations), and a complete command reference. Internal READMEs for llm/, workspace/, and the newly added cmd/template/README.md were expanded to explain their subpackages, public APIs, and how they interact. This makes it easier for new contributors and users to navigate the project and understand how the pieces fit together.
Introduce dedicated documentation files for the most complex sub-packages under the workspace tree: • workspace/project – explains the metadata model (Module, FileRef), annotation workflow and lifecycle of `.vyb/metadata.yaml`. • workspace/matcher – describes the advanced .gitignore-style pattern engine and how inclusion/exclusion logic is applied. • workspace/selector – documents the file-selection algorithm that powers every AI command, including traversal rules and interaction with matcher. These additions complement the existing high-level docs and make it much easier for contributors to navigate the codebase.
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.
Now the module matched the repo location (fixes #20 ). Also updated existing README.md files, and created new ones where appropriate.