docs: fix missing @ prefix in namespace resolution examples #14
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
Bundle namespace references in YAML frontmatter require the @ prefix to resolve correctly. Without it, paths fail to resolve with 'file not found' errors. Fixed 7 incorrect examples in BUNDLE_GUIDE.md that showed namespace references without the @ prefix: - Lines 74, 103, 167, 252, 393, 556, 615 Added comprehensive 'Namespace Resolution Rules' section explaining: - When @ prefix is required (context includes, bundle includes, agents) - Correct vs incorrect examples for each pattern - Why the @ prefix matters (triggers namespace resolution) Related: DavidKoleczek/amplifier-expert-cookbook@94ee8bf This issue was discovered while setting up a bundle with recipes in a subdirectory. The recipe path resolution failed until @ prefix was added.
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.
Summary
Bundle namespace references in YAML frontmatter require the
@prefix to resolve correctly. Without it, paths fail to resolve with 'file not found' errors. This PR fixes incorrect examples in the documentation that would have led users to encounter these errors.Changes
Fixed 7 incorrect examples in
docs/BUNDLE_GUIDE.mdthat showed namespace references without the@prefix:Added comprehensive 'Namespace Resolution Rules' section explaining:
@prefix is required (context includes, bundle includes, agents)@prefix matters (triggers namespace resolution)Why This Matters
Users following the documentation examples would encounter 'file not found' errors when trying to use namespace references without the
@prefix. This fix ensures all examples in the guide are accurate and will work correctly when used.Related
This fix was identified while working on using recipes in a bundle, see:
There is another closed PR where a docstring was updated to emphasize the @ notation for recipes which might be a good idea as well.
Test Plan
@prefix syntax🤖 Generated with Amplifier
Co-Authored-By: Amplifier 240397093+microsoft-amplifier@users.noreply.github.com