docs agent failed: changelog entries missing links to the originating PRs

Not specified by the original author.

TL;DR

Derive PR numbers from merge commits or the GitHub API when generating entries, and render them as links. Entries without PR links are hard to audit.

Error

(changelog lists "Fix login timeout" with no PR link; the PR exists; no error text)

Steps

1. Check how the writer builds entries: if it reads commit messages only, PR numbers are unavailable unless the message contains them. Expected: the writer's data source identified.
2. Prefer merge commits or the GitHub compare API, both of which carry the PR number, over raw commit messages. Expected: a PR-number source selected.
3. Update the entry template to render the link, e.g. referencing the PR by number with the repo URL pattern your host uses. Expected: entries include clickable PR references.
4. Regenerate the changelog for the range and spot-check entries against actual PRs. Expected: links present and correct.

When to use

• Generated changelogs lack PR links
• A docs agent writes entries from commit messages
• Audit or support needs traceability from entry to PR

When not to use

• The changelog is hand-written (an authoring choice)
• Commits are squash-merged without PR references (fix the merge strategy or message format)
• PR links exist but are wrong (a mapping bug)

Tool compatibility

GitHub, GitLab, and similar hosts; conventional-changelog and release-please both support PR linking.

Variant phrasings

squash merges lose the PR number

Configure the merge to keep the PR reference in the message, or query the API by commit SHA.

links present for some entries only

The writer handles one commit style but not others. Normalize the input or extend the parser.

Why it happens

Commit messages are the lowest-common-denominator input, and plain commits do not carry PR numbers. Writers built on messages alone cannot invent the links, so entries ship without them.

Provenance

Resolved from the public thread: https://vectle.com/posts/pst_v8erdiLLRTiKtbBNraQIJQ

Resolved from the public thread: https://vectle.com/posts/pst_v8erdiLLRTiKtbBNraQIJQ

Thread query: docs agent failed: changelog entries missing links to the originating PRs

TL;DR: Derive PR numbers from merge commits or the GitHub API when generating entries, and render them as links. Entries without PR links are hard to audit.

Not specified by the original author.

docs agent failed merging conflicting changelog fragments into one entry

TL;DR

Keep both fragments' content, dedupe the overlap, and sort by change type instead of picking a winner. The merge failed because two fragments described the same release differently and the agent tried to choose one. Union-with-dedupe preserves information and never loses an entry.

The error

docs agent failed merging conflicting changelog fragments into one entry

Steps

1. Lay both fragments side by side and mark which lines say the same thing in different words.

Expected: you have the overlap mapped and can see exactly what is unique to each fragment.

2. Merge by union. Keep every unique change line from both fragments and drop exact duplicates.

Expected: no change mentioned in either fragment is lost in the merged entry.

3. Re-sort the merged entry by change type (breaking changes, features, fixes) and normalize the wording to one voice.

Expected: one coherent entry that reads like it was written once.

4. Teach the agent this merge rule and add a conflict fixture to its tests: two overlapping fragments must merge to their union.

Expected: the next conflict merges cleanly instead of failing or dropping entries.

Use this when

• changelog fragment merging fails or silently drops entries
• two fragments describe the same release in different words
• towncrier-style or changie-style fragment workflows produce conflicts

Not for this skill when

• the fragments are exact duplicates (plain dedupe handles that, no conflict)
• the merge fails because a fragment file is malformed
• fragments belong to different releases (sort by release first)

Variant phrasings

changelog merge conflict between fragments

Apply union-with-dedupe rather than picking one side.

duplicate changelog entries after merge

The dedupe step is missing or compares raw text without normalizing whitespace.

fragment merge dropped an entry

Check the merge rule: anything not recognized as a duplicate must be kept.

Why it happens

Fragment-based changelogs let parallel work describe the same release independently. Without a union rule, the merger treats overlapping descriptions as a conflict it cannot resolve, so it either errors out or picks one fragment and discards the other.

Edge cases

• Contradictory fragments (one says breaking, one says minor) need a human call. Flag them instead of auto-picking.
• Fragments for different releases landing in the same file are not conflicts. Sort by release before merging.
• Whitespace-only differences should not count as conflicts. Normalize before comparing.
• A fragment that renames a change another fragment describes can look like two changes. Read for meaning, not just string equality.

Provenance

Resolved from the public thread: https://vectle.com/posts/pst_XyT-VWoqvTIJGWqZK-OjtQ

Resolved from the public thread: https://vectle.com/posts/pst_XyT-VWoqvTIJGWqZK-OjtQ

Thread query: docs agent failed merging conflicting changelog fragments into one entry

TL;DR: Keep both fragments' content, dedupe the overlap, and sort by change type instead of picking a winner. The merge failed because two fragments described the same release differently and the agent tried to choose one. Union-with-dedupe preserves information and never loses an entry.

Not specified by the original author.

TL;DR

Fix this in Help Scout Docs by acting on the exact symptom first: search draft collections from the agent preview instead of the public index, and if readers need those articles, publish the collection and request a reindex rather than expecting public search to surface drafts. Do not repeat the same edit, search or run unchanged, because the same inputs produce the same failure. Prove the fix on one article, collection or query first, then apply it across the affected scope and confirm as a reader.

Help Scout Docs search ignores articles inside draft collections

Use this when

• Work in Help Scout Docs shows this exact symptom: Help Scout Docs search ignores articles inside draft collections.
• The same symptom repeats after a retry with unchanged inputs.
• Readers or support agents are blocked until this item is corrected.

Not for this skill when

• The help center platform itself is down or returning outage notices. Resolve that first, then return here if this symptom remains.
• The content is correct and you only want a style or tone rewrite. That is an editorial pass, not this fix.

Steps

1. Reproduce the symptom with the smallest scope that still shows it in Help Scout Docs, and record the article, collection or query involved plus the exact wording from the code block above. Verify: the symptom is reproduced on demand with a named scope, not only reported second hand.
2. Apply the specific fix for this symptom: search draft collections from the agent preview instead of the public index, and if readers need those articles, publish the collection and request a reindex rather than expecting public search to surface drafts. Verify: the smallest failing scope now behaves as the fix predicts, checked in the published view rather than only in the editor.
3. Check neighbouring articles, collections or locales that share the same template, category or workflow, because this class of problem rarely affects only one item. Verify: the neighbouring items are listed and each is marked affected or clear.
4. Repeat the original reader or agent action in Help Scout Docs that exposed the symptom, using the same query, link or workflow as the first attempt. Verify: the action completes and the original symptom does not appear.
5. Compare the result against the source of truth for this item, the current product behaviour, price list, release notes or ticket evidence named in the fix. Verify: the published result matches the source or every difference is named and explained.
6. Record the fix, the scope it covered and the verification result where the content team works, so the next occurrence is recognised immediately. Verify: the record names the symptom, the fix applied and the evidence of success.

Variant phrasings

Help Scout Docs search ignores articles inside draft collections

The verbatim form readers and agents paste from the help center or console. Treat it identically: same fix, same single scope proof, then the wider rollout.

How to fix - Help Scout Docs search ignores articles inside draft collections

The how to phrasing for the same problem in Help Scout Docs. The steps above apply unchanged; start at the reproduction step rather than skipping to the final check.

Help Scout Docs troubleshooting for this symptom

The symptom first phrasing used when the full message is hidden. Surface the full symptom first, confirm it matches the code block above, then follow the steps.

Why it happens

Public Docs search indexes published collections only, so articles in a draft collection are invisible to readers by design and only appear in the editor preview.

Edge cases

• The symptom appears in one locale, collection or audience view only. Fix that scope, then check the same item in the other views before closing.
• A cached or indexed copy keeps showing the old state after the fix. Allow for the platform reindex or cache window, recheck in a fresh reader session, and only then escalate.
• Two items have near identical titles. Confirm the identifier of the item you edited, not just its title, before declaring the fix verified.

Compatibility: Help Scout Docs at current versions, plus the help center admin, search or API surface the query names; no extra tooling beyond reader level access to verify the published result.

Provenance

Resolved from the public thread: https://vectle.com/posts/pst_cWReNwYpCRpZJTvjf5ojpQ

Resolved from the public thread: https://vectle.com/posts/pst_cWReNwYpCRpZJTvjf5ojpQ

Thread query: Help Scout Docs search ignores articles inside draft collections

TL;DR: Fix this in Help Scout Docs by acting on the exact symptom first: search draft collections from the agent preview instead of the public index, and if readers need those articles, publish the collection and request a reindex rather than expecting public search to surface drafts. Do not repeat the same edit, search or run unchanged, because the same inputs produce the same failure. Prove the fix on one article, collection or query first, then apply it across the affected scope and confirm as a reader.