fix(docs): remove unsupported Developer API guidance#130
Merged
Conversation
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.
Intent
Correct the public Connect website's unsupported Developer API documentation for the current Connect-Java 0.11.0 surface. Keep this a docs-only correction: remove the Developers API navigation and the unsupported API/client/authentication/super-endpoint/code-example pages plus their generated-example sources and direct guide links; add regression coverage that the unavailable routes and navigation do not return. Preserve the separate AuthSession documentation that explicitly says unavailable. Do not alter application/runtime behavior, API implementation, production configuration, deployment, blog posts, or the files associated with open Connect PRs #103/#105. Do not publish or retain actionable setup, authentication headers, JitPack/artifact advice, generated-stub examples, endpoint-control claims, or sensitive-looking samples. Validate the exact committed head, without --yes.
What Changed
Risk Assessment
✅ Low: The change is a well-bounded documentation correction that removes the unsupported routes, navigation, examples, and direct guide references while preserving the explicitly unavailable AuthSession documentation.
Testing
At clean HEAD
aa20a964f03b0e5095ef164842bf928c74bbb189, an immutable install resolved the initial setup gap and port 4179 avoided an occupied 4173; docs assertions and the production build completed, rendered-site checks showed no Developers API navigation, preserved the explicit AuthSession-unavailable page, and returned 404 for all ten retired-route variants. Three screenshots and a route transcript were captured, prohibited-content and live PR-scope checks were run, and generated install/build outputs were removed; the remaining issue is the PR #103 file/link conflict./var/folders/1y/cjgf53nj31n_dxsspqnjfjvc0000gn/T/no-mistakes-evidence/01KXD944V92MVXNVDQEBJSWKGY/guide-navigation-without-developer-api.png)/var/folders/1y/cjgf53nj31n_dxsspqnjfjvc0000gn/T/no-mistakes-evidence/01KXD944V92MVXNVDQEBJSWKGY/authsession-unavailable-preserved.png)/var/folders/1y/cjgf53nj31n_dxsspqnjfjvc0000gn/T/no-mistakes-evidence/01KXD944V92MVXNVDQEBJSWKGY/developer-api-route-404.png)Evidence: Built docs route verification
Evidence: Open-PR scope overlap
Pipeline
Updates from git push no-mistakes
✅ **intent** - passed
✅ No issues found.
✅ **Rebase** - passed
✅ No issues found.
✅ **Review** - passed
✅ No issues found.
.web/docs/guide/api/authentication.md- Target commitaa20a964…deletes.web/docs/guide/api/authentication.md, but open PR docs: launch Connect libp2p transport #103 modifies that same file and its new blog post links to/guide/api/authentication. This violates the stated constraint not to alter files associated with PR docs: launch Connect libp2p transport #103 and allows a later PR docs: launch Connect libp2p transport #103 merge to restore the unsupported page or retain a dead link. Retaining the file conflicts with the core removal goal, while changing PR docs: launch Connect libp2p transport #103's blog conflicts with the protected-blog constraint, so author coordination is required.git status --short --branch,git rev-parse HEAD, and base-to-targetgit diffinspectionInitialmise exec node@24 -- corepack yarn check:docs && mise exec node@24 -- corepack yarn build(blocked by missing local install)mise exec node@24 -- corepack yarn install --immutableRetriedmise exec node@24 -- corepack yarn check:docs && mise exec node@24 -- corepack yarn buildmise exec node@24 -- corepack yarn serve --host 127.0.0.1 --port 4179(4173 was occupied)Built-site fetch checks for/guide/,/guide/auth-api.html, and extensionless/.htmlforms of the five retired Developer API routeschrome-devtools-axibrowser checks and screenshots for the guide, AuthSession, and retired API routergscans of public source and generated output for retired links, navigation, authentication headers, JitPack/artifact guidance, generated stubs, endpoint-control claims, and sensitive-looking samplesgh-axi pr viewandgh-axi pr diff --fullfor open PRs #103 and #105Finalmise exec node@24 -- node .web/scripts/check-docs.mjs, exact-HEAD/clean-worktree check, and transient-output cleanup verification✅ **Document** - passed
✅ No issues found.
✅ **Lint** - passed
✅ No issues found.
✅ **Push** - passed
✅ No issues found.