Skip to content

πŸ›πŸ§‘β€πŸ’» - bug generated agent guidance links to documentation missing in target repositoriesΒ #539

Closed

Description

@efraespada

Is there an existing issue for this?

  • I have searched the existing issues.

Which actions are affected?

No response

Which platforms are affected?

No response

Description

Installing Copilot in a repository other than vypdev/copilot generates .copilot/AGENT_GUIDE.md with relative links to ../docs/agents/repository-collaboration.mdx and ../docs/agents/repository-guidance-troubleshooting.mdx. Those files exist in the Copilot source repository but are not installed in the target, so the guide sends contributors to missing local files / GitHub 404s. This is reproduced in vypdev/platform after platform setup PR #166.

Expected: links to shared Copilot documentation resolve to centrally maintained documentation independently of the destination repository; links to installed local artifacts such as ./repository-profile.json remain local.

Recommended fix: use absolute HTTPS links to the documentation in vypdev/copilot, with one canonical version/ref policy, and keep user/project-specific guidance local. The existing source pages are verified at https://github.com/vypdev/copilot/blob/master/docs/agents/repository-collaboration.mdx and https://github.com/vypdev/copilot/blob/master/docs/agents/repository-guidance-troubleshooting.mdx. Audit generated guide/skill/pointer references for the same portability issue.

Keep this bounded bug separate from organization reuse and multi-repository setup issue #538. Copying the whole docs tree into every target would add upgrade/drift ownership and is not the preferred solution.

Reproducing the issue

  1. Install Copilot with repository agent guidance enabled in a clean target repository without the Copilot docs tree (for example vypdev/platform).
  2. Open .copilot/AGENT_GUIDE.md and follow its last two documentation links.
  3. Resolve them relative to .copilot/: the target paths are docs/agents/repository-collaboration.mdx and docs/agents/repository-guidance-troubleshooting.mdx, which setup does not install. GitHub returns 404.
  4. Compare the same guide in vypdev/copilot, where the files happen to exist and conceal the portability defect.

Acceptance: fresh target installations use canonical absolute documentation URLs; all relative Markdown links in generated guidance resolve to artifacts actually installed in that target; repeated setup upgrades hash-owned old guidance and its manifest safely; edited/unowned guidance is preserved with the normal conflict report; checked-in guidance and packaged CLI/Action outputs match the generator. Add focused regression coverage, refresh related guidance docs/SDD/catalog evidence, and run the existing documentation/package/contract gates.

copilot Version

3.5.5; platform setup at 5554e78a6211decb9a658640af9e07771ab9582e

Relevant Log Output

Generated in .copilot/AGENT_GUIDE.md:
[repository collaboration](../docs/agents/repository-collaboration.mdx)
[guidance troubleshooting](../docs/agents/repository-guidance-troubleshooting.mdx)

Additional context and comments

User-reported during Copilot setup dogfooding. The actual generated directory is .copilot (the report mentioned .compilot). Generator: src/application/policies/repository_agent_guidance_policy.ts, renderRepositoryAgentGuide. Reconciliation/ownership: src/utils/repository_agent_guidance.ts. Relevant capability: repository-agent-collaboration; SDD: specs/repository-agent-collaboration-contract.md. No documentation copies or configurable arbitrary documentation hosts are needed for this correction.

Activity

  1. added
    bugSomething isn't working
    bugfixSomething isn't working
    priority: highCritical issue, needs immediate attention.
    on Oct 17, 2026
  2. added theissue type on Oct 17, 2026
  3. moved this to Todo in vypdevon Oct 17, 2026
  4. changed the title [-]bug: generated agent guidance links to documentation missing in target repositories[/-] [+]πŸ› - bug generated agent guidance links to documentation missing in target repositories[/+] on Oct 17, 2026
  5. vypbot commented on Oct 17, 2026

    @vypbot
    Contributor

    Hi! I’m @vypbot, the Copilot assistant for this repository.

    I can answer questions, explain the codebase, propose implementation and test plans, review issues and pull requests for potential bugs or security problems, and help authorized maintainers apply changes.

    Try /copilot help to see the available commands, or mention @vypbot with your question.

  6. moved this from Todo to In Progress in vypdevon Oct 17, 2026
  7. added
    branchedIndicates that a branch has been created for this issue.
    on Oct 17, 2026
  8. changed the title [-]πŸ› - bug generated agent guidance links to documentation missing in target repositories[/-] [+]πŸ›πŸ§‘β€πŸ’» - bug generated agent guidance links to documentation missing in target repositories[/+] on Oct 17, 2026
  9. 3 remaining items

  10. vypbot commented on Oct 17, 2026

    @vypbot
    Contributor

    Implementation plan

    Current status: Ready to start. No action is required from maintainers before implementation.

    1. Update the generated guide links
      • In `src/application/policies/repository_agent_guidance_policy.ts`, link shared documentation to canonical HTTPS URLs in `vypdev/copilot` using one version/ref policy.
      • Keep links to installed artifacts, such as `./repository-profile.json`, relative and local.
    2. Audit generated guidance references
      • Review guide, skill, and pointer references for relative links to files that setup does not install; keep user- and project-specific guidance local.
    3. Add focused regression coverage
      • Verify fresh setup emits canonical documentation URLs and every relative Markdown link in generated guidance resolves to an installed artifact.
      • Verify repeated setup safely reconciles hash-owned guidance and manifest while preserving edited or unowned files and reporting conflicts.
    4. Refresh contract and generated artifacts
      • Update `specs/repository-agent-collaboration-contract.md`, its catalog evidence, and related guidance documentation.
      • Confirm checked-in guidance and packaged CLI/Action outputs match the generator.
    5. Run the relevant project gates
      • Run focused regression coverage and the existing documentation, package, and contract validation gates.

    Acceptance: A fresh installation into a target without the Copilot docs tree emits canonical absolute HTTPS links to both shared documentation pages, and every relative Markdown link in generated guidance resolves to an installed artifact; regression coverage confirms safe ownership reconciliation, conflict preservation, and generator-to-package parity.

    Need something else? Mention the bot with a question or use /copilot help.

  11. added
    size: XLIndicates that the issue or task is extra large in scope and complexity.
    85%Progress: 85%
    and removed on Oct 17, 2026
  12. vypbot commented on Oct 17, 2026

    @vypbot
    Contributor

    Issue closed β€” historical progress

    Current status: closed as completed.

    The last estimate is retained below as history. Closure does not certify a new percentage, tests, or branch alignment.

    Action required: none for this closed issue. If work continues, reopen the issue; a fresh assessment can update this same card.

    Last assessment before closure (historical)

    Progress: 85% β€” in progress

    > Current status: The generator and checked-in guide now use canonical absolute documentation URLs. Regression coverage checks fresh-install links and safe upgrades of hash-owned legacy guides, and the contract and guidance documentation were updated. The comparison does not establish that conflict preservation, generated CLI/Action parity, or the required project gates were verified; build metadata alone is not verification.

    Next: Verify edited and unowned guide preservation with conflict reporting, confirm generator-to-CLI/Action parity, and run the focused regression plus documentation, package, and contract gates.

  13. added a commit that references this issue on Oct 17, 2026
  14. vypbot commented on Oct 17, 2026

    @vypbot
    Contributor

    Issue closed: synchronization recommendation retired

    No branch synchronization is required for this closed issue.

    The previous recommendation is historical. Issue closure does not certify that the branches are synchronized.

  15. moved this from In Progress to Done in vypdevon Oct 17, 2026
  16. added
    100%Progress: 100%
    and removed
    in-progressStart work on an admitted issue.
    state:workingWork can proceed on the verified branch or without a branch.
    on Oct 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

100%Progress: 100%branchedIndicates that a branch has been created for this issue.bugSomething isn't workingbugfixSomething isn't workingpriority: highCritical issue, needs immediate attention.size: XLIndicates that the issue or task is extra large in scope and complexity.

Type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions