Skip to content

docs(#5954): link per-repo config header to user-facing docs - #5956

Open
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/5954-config-header-link
Open

docs(#5954): link per-repo config header to user-facing docs#5956
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/5954-config-header-link

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

Summary

Replace the bare "ADR 0033" reference in the generated per-repo .fullsend/config.yaml header with a direct link to the published user-facing documentation at https://fullsend.sh/docs/guides/infrastructure/layered-config-reference.

Related Issue

Closes #5954

Changes

  • Update perRepoConfigHeader in internal/config/config.go to replace the internal ADR citation with the published docs URL
  • Add TestPerRepoConfigHeaderPointsToUserDocs regression test asserting the header links to user-facing docs and does not reference internal ADRs

Testing

  • go test ./internal/config/... passes
  • New test TestPerRepoConfigHeaderPointsToUserDocs added and passing
  • go vet ./internal/config/... passes
  • Secret scan passes

Closes #5954

Post-script verification

  • Branch is not main/master (agent/5954-config-header-link)
  • Secret scan passed (gitleaks — 900d4f429bf350a5a86701d97c08af848d48caf5..HEAD)
  • PR body secret scan passed (gitleaks — no-git)

The perRepoConfigHeader constant referenced "ADR 0033" — an
internal design record with no link. Users reading their
generated .fullsend/config.yaml had no way to find it, and
ADRs are written for maintainers, not end users.

Replace the bare ADR reference with a direct URL to the
published layered-config-reference guide on fullsend.sh.
Add a regression test asserting the header links to
user-facing docs and does not cite internal ADRs.

Closes #5954

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@fullsend-ai-coder
fullsend-ai-coder Bot requested a review from a team as a code owner August 5, 2026 20:08
@fullsend-ai-coder fullsend-ai-coder Bot added the ready-for-review Agent PR ready for human review label Aug 5, 2026
@fullsend-ai-review

fullsend-ai-review Bot commented Aug 5, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 8:09 PM UTC · Completed 8:18 PM UTC
Commit: 7833d85 · View workflow run →

@codecov

codecov Bot commented Aug 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@fullsend-ai-review

Copy link
Copy Markdown

Looks good to me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-merge All reviewers approved — ready to merge ready-for-review Agent PR ready for human review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: per-repo config.yaml header cites "ADR 0033" with no link, and ADRs aren't user-facing

0 participants