Skip to content

[docs] Self-healing documentation fixes from issue analysis - 2026-06-27 #41816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 1 commit into from
Jun 27, 2026
+1 −1
Merged

[docs] Self-healing documentation fixes from issue analysis - 2026-06-27 #41816

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/content/docs/setup/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ After waiting for the workflow to complete, check the new issue created with you

## What's next?

There are hundreds of other ways to use GitHub Agentic Workflows! Explore some of these in [Peli's Agent Factory](https://github.github.com/gh-aw/blog/2026-01-12-welcome-to-pelis-agent-factory/).
There are hundreds of other ways to use GitHub Agentic Workflows! Explore the [Agent Factory blog series](https://github.github.com/gh-aw/blog/2026-01-12-welcome-to-pelis-agent-factory/) — a 19-part tour of real-world agentic workflows authored by the gh-aw maintainers — for examples covering issue triage, releases, quality checks, and more.

@github-actions github-actions Bot Jun 27, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[/grill-with-docs] The attribution "authored by the gh-aw maintainers" conflicts with the blog series' own credits — the welcome post attributes the work to "GitHub Next, Microsoft Research and collaborators, including Peli de Halleux, Don Syme, Mara Kiefer, Edward Aftandilian, Russell Horton, Jiaxiao Zhou." Framing it as "gh-aw maintainers" misrepresents the provenance.

💡 Suggested fix

Replace:

authored by the gh-aw maintainers

With:

by GitHub Next and collaborators

This matches the language in the welcome post itself (2026-01-12-welcome-to-pelis-agent-factory.md) and avoids narrowing the credit to just one team.

@copilot please address this.

@github-actions github-actions Bot Jun 27, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[/grill-with-docs] The FAQ still refers to the series by its original name — docs/src/content/docs/reference/faq.md line 504 uses [Peli's Agent Factory](/gh-aw/blog/2026-01-12-welcome-to-pelis-agent-factory/). A reader clicking through from Quick Start will land on a page titled "Welcome to Peli's Agent Factory!", creating a mismatch with the new "Agent Factory blog series" label.

💡 Suggested fix

For full consistency, update faq.md line 504:

# Before
See [Peli's Agent Factory](/gh-aw/blog/2026-01-12-welcome-to-pelis-agent-factory/).

# After
See [Agent Factory blog series](/gh-aw/blog/2026-01-12-welcome-to-pelis-agent-factory/).

Alternatively, leave the FAQ as-is and accept that both names co-exist — but the PR description's stated goal is to remove the personal-branded reference, which would benefit from being applied consistently.

@copilot please address this.

@github-actions github-actions Bot Jun 27, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hardcoded series count will go stale: 19-part is a fixed factual claim that will silently become incorrect as the blog series grows.

💡 Suggested fix

Drop the count or phrase it as approximate:

Explore the [Agent Factory blog series](https://github.github.com/gh-aw/blog/2026-01-12-welcome-to-pelis-agent-factory/) — a multi-part tour of real-world agentic workflows authored by the gh-aw maintainers — for examples covering issue triage, releases, quality checks, and more.

A blog series that grows beyond 19 (or is restructured) will make this sentence quietly wrong with no build-time signal.

@github-actions github-actions Bot Jun 27, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link text mismatches the actual page title: the linked blog post is titled "Welcome to Peli's Agent Factory" — readers who click "Agent Factory blog series" will land on a page with a noticeably different name, eroding trust and causing confusion.

💡 Details

The target URL resolves to a page whose <title> and H1 are Welcome to Peli's Agent Factory. The new link text Agent Factory blog series diverges from that canonical title. A reader who clicks the link expecting a series index will instead land on a single introductory article whose title doesn't match what they clicked.

Additionally, the series actually contains 20 posts (1 welcome + 19 "meet the workflows" entries), so the 19-part count is already incorrect — not merely a future-staleness risk.

A closer and more accurate rephrasing:

Explore [Peli's Agent Factory](https://github.github.com/gh-aw/blog/2026-01-12-welcome-to-pelis-agent-factory/) — a blog series walking through real-world agentic workflows covering issue triage, releases, quality checks, and more.

This preserves the canonical series name while still adding the descriptive context that Issue #40806 asked for.


Continue learning with these resources:

Expand Down
Loading