Skip to content

Comments

docs: fix missing @ prefix in namespace resolution examples#14

Closed
robotdad wants to merge 1 commit intomicrosoft:mainfrom
robotdad:docs/fix-namespace-resolution-at-prefix
Closed

docs: fix missing @ prefix in namespace resolution examples#14
robotdad wants to merge 1 commit intomicrosoft:mainfrom
robotdad:docs/fix-namespace-resolution-at-prefix

Conversation

@robotdad
Copy link
Member

@robotdad robotdad commented Jan 7, 2026

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.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)

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

  • Verified all corrected examples now use proper @ prefix syntax
  • Reviewed Namespace Resolution Rules section for accuracy
  • Confirmed changes align with actual namespace resolution behavior

🤖 Generated with Amplifier

Co-Authored-By: Amplifier 240397093+microsoft-amplifier@users.noreply.github.com

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.
@bkrabach
Copy link
Collaborator

bkrabach commented Feb 8, 2026

Thanks for the documentation attention, @robotdad. After investigation, the @ prefix additions to YAML includes: and context.include: examples are incorrect — the actual working bundles in the repo all use the bare namespace format:

# How it works today (correct):
includes:
  - bundle: foundation:behaviors/foundation-expert
  - bundle: foundation:behaviors/sessions

context:
  include:
    - foundation:context/agents/delegation-instructions.md

The @ prefix is for markdown body mentions (inline expansion), not YAML frontmatter entries. Adding @ to the YAML examples would teach users the wrong syntax.

The "Namespace Resolution Rules" section added by the PR is built on this same incorrect premise, so we can't merge it as-is.

Closing this one — if you'd like to contribute a documentation clarification that distinguishes when @ IS vs ISN'T needed (markdown body vs YAML frontmatter), that would be a valuable addition.

@bkrabach bkrabach closed this Feb 8, 2026
bkrabach added a commit that referenced this pull request Feb 13, 2026
Distill learnings from reviewing PRs #14 (amplifier-core) and #78
(amplifier-foundation) with the project owner. Captures metadata
philosophy, extensibility patterns, and code quality standards.

New entries:
- Ecosystem Conventions & Event Design subsection (4 entries):
  metadata naming, proactive extensibility slots, raw-data-through
  pattern, promotion threshold for helpers
- PR Review subsection additions (3 entries):
  zero-consumer compat burden, no fragile approaches, exemplar
  contract docs

🤖 Generated with [Amplifier](https://github.com/microsoft/amplifier)

Co-Authored-By: Amplifier <240397093+microsoft-amplifier@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants