Consolidate #582 and #625 into the published developer relations docs article - #865
Open
InlinePizza wants to merge 2 commits into
Open
Consolidate #582 and #625 into the published developer relations docs article#865InlinePizza wants to merge 2 commits into
InlinePizza wants to merge 2 commits into
Conversation
Consolidates the two remaining add/add collisions on developer-relations-docs.mdx into the published article from #815. Salvaged from #582: the linked Postman 2024 State of the API statistic (39% of developers name inconsistent documentation their biggest roadblock), and the mechanism by which a stale page read early in an assistant session becomes an assumption for every later step. Salvaged from #625: the drift-rate ordering within procedural content with its differentiated review cadence, and the docs-to-API-surface dependency map as a fourth explicit item in the ownership model. Everything else in both PRs duplicated the incumbent or rested on unsourced or misattributed statistics.
InlinePizza
requested review from
adit-chandra,
frances720,
hawkeyexl and
mattlink
as code owners
August 14, 2026 18:10
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Documentation review — approve.
Reviewed the consolidation of salvage from #582 and #625 into developer-relations-docs.mdx as the page's reader, against source and the collection's conventions.
Correctness against source (verified, not from memory)
- The one new external citation checks out. Postman's 2024 State of the API report states verbatim: "58% of developers rely on internal documentation, but 39% say inconsistent docs are the biggest roadblock." The article's phrasing — 39% named inconsistent documentation their biggest roadblock when working with APIs — faithfully represents it, and the linked report resolves. Good call dropping the misattributed 68% figure and the unsupported userguiding.com link rather than shipping them.
- All six internal cross-links resolve on this branch, including the newly added
/blog/technical/agent-context-engineering. - The salvaged mechanism claims (per-session compounding of a stale read; the drift-rate cadence; the page-to-API-surface dependency map) are reasoned analytical points in the article's own voice, not statistics dressed as sourced findings — appropriate to assert without a citation.
Quality, style & repo conventions
- On-voice for this collection: second person, present tense, concrete scenarios. 0 em dashes, no "will"-as-future, sentence-case headings — all consistent with house style. Body word count lands in the 800–1400 range.
- The salvage is folded into the existing structure (a fourth ownership item; drift-ordering inside the procedural section) rather than bolted on as new sections, and the compensating compressions don't drop any argument.
Audience fit
- Reads well for the DevRel/DevEx owner this page serves: the differentiated review cadence (quickstarts/code samples/auth flows every release, concepts quarterly) and the page-dependency map are exactly the operational specifics that persona reaches for, and they make the abstract "add a trigger" advice actionable.
No correctness, convention, or quality issues that would mislead a reader. The merge decision remains yours.
Automated documentation review by Promptless.
The 800-1400 house range no longer binds this article. Eight passages had been compressed purely to fit the salvage underneath the ceiling; all eight are back to their #815 published wording verbatim. The diff against the published article is now purely additive: the four salvaged items plus the bullet-count change, and nothing else. Also moved the salvaged risk-ordering paragraph to sit after the gap-persists paragraph rather than before it. In its previous position it separated 'This gap persists because...' from its antecedent two paragraphs back. Nothing on the dropped list was reinstated.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Consolidates the two remaining add/add collisions on
src/content/blog/technical/developer-relations-docs.mdxinto the canonical page published by #815, then clears the way to close both source PRs.#582 and #625 were each written as a whole competing article on the same thesis the incumbent already argues: DevRel docs go stale because ownership is split and nothing triggers a synchronized update. Neither can be merged as-is. This PR takes the parts that add a distinct mechanism or a defensible piece of evidence and folds them into the existing structure and voice, rather than bolting on new sections.
Salvaged from #582
agent-context-engineering.Salvaged from #625
Deliberately dropped
From #582
From #625
Word count and house style
The 800-1400 house range was deliberately lifted for this article by the reviewing human after the first round. This is a consolidation of three articles into one canonical page, so the length is an intentional decision, not an oversight or a missed check.
The first version of this PR came in at 1,399 words because eight passages of published prose had been compressed to fit the salvage under the old ceiling. With the ceiling lifted, all eight were restored to their #815 wording verbatim. The diff against the published article is now purely additive: the four salvaged items and the bullet-count change, and nothing else. No published sentence is altered or removed.
Nothing on the dropped list was reinstated when the room appeared. Those items were rejected for duplicating the incumbent or for resting on unsourced or misattributed claims, and neither reason has anything to do with length.
Plain-language review
Ran
plain-language-reviewon the first draft and acted on all six findings: moved the new drift-ordering paragraph so it stops interrupting a thread, named the three content types instead of a vague "those three" back-reference, completed the Postman claim with the scope the statistic actually has and cut a straw contrast, replaced agent-engineering vocabulary with the article's own authentication example, folded a standalone cross-reference into its paragraph, and replaced a hedged bullet ending with a concrete consequence.Ran a second pass scoped to the restored passages and their seams. It surfaced one real defect, which came from my own insertion rather than from the restoration: the risk-ordering paragraph had been placed between "That gap sits between what the docs say and what the API does" and "This gap persists because…", leaving that demonstrative reaching back over two paragraphs of new subjects. The paragraph now sits after the gap-persists paragraph instead, which restores the published adjacency exactly. That is the only seam fix; the other seven restorations were clean reverts.
Closes #582 and #625 by consolidation. No other PR in the
developer-relations-docscluster was touched.