Skip to content

fix(docs): remove unsupported Developer API guidance#130

Merged
robinbraemer merged 2 commits into
mainfrom
fm/connect-developer-api-docs-correction-j4
Jul 13, 2026
Merged

fix(docs): remove unsupported Developer API guidance#130
robinbraemer merged 2 commits into
mainfrom
fm/connect-developer-api-docs-correction-j4

Conversation

@robinbraemer

Copy link
Copy Markdown
Member

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

  • Removed the unsupported Developer API navigation, guide pages, client/authentication guidance, endpoint controls, and generated Go/Java examples.
  • Updated guide and blog copy to stop claiming unavailable public API capabilities.
  • Added docs checks that fail if retired navigation, links, pages, or examples are restored.

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.

  • Evidence: Guide navigation without Developers API (local file: /var/folders/1y/cjgf53nj31n_dxsspqnjfjvc0000gn/T/no-mistakes-evidence/01KXD944V92MVXNVDQEBJSWKGY/guide-navigation-without-developer-api.png)
  • Evidence: Preserved AuthSession unavailable notice (local file: /var/folders/1y/cjgf53nj31n_dxsspqnjfjvc0000gn/T/no-mistakes-evidence/01KXD944V92MVXNVDQEBJSWKGY/authsession-unavailable-preserved.png)
  • Evidence: Retired Developer API route 404 (local file: /var/folders/1y/cjgf53nj31n_dxsspqnjfjvc0000gn/T/no-mistakes-evidence/01KXD944V92MVXNVDQEBJSWKGY/developer-api-route-404.png)
Evidence: Built docs route verification
PASS /guide/ -> 200 Minekube Connect Introduction | Minekube Connect
PASS /guide/ has no Developers API navigation label
PASS /guide/ has no direct /guide/api/ link
PASS /guide/ retains AuthSession API navigation
PASS /guide/auth-api.html -> 200 AuthSession API Coming soon | Minekube Connect
PASS AuthSession page visibly says the feature is currently unavailable
PASS AuthSession page retains the production-unavailable status
PASS /guide/api/ -> 404 404 | Minekube Connect
PASS /guide/api/index.html -> 404 404 | Minekube Connect
PASS /guide/api/clients -> 404 404 | Minekube Connect
PASS /guide/api/clients.html -> 404 404 | Minekube Connect
PASS /guide/api/authentication -> 404 404 | Minekube Connect
PASS /guide/api/authentication.html -> 404 404 | Minekube Connect
PASS /guide/api/super-endpoints -> 404 404 | Minekube Connect
PASS /guide/api/super-endpoints.html -> 404 404 | Minekube Connect
PASS /guide/api/examples -> 404 404 | Minekube Connect
PASS /guide/api/examples.html -> 404 404 | Minekube Connect
Evidence: Open-PR scope overlap
Target aa20a964 deletes `.web/docs/guide/api/authentication.md`; live open PR #103 modifies that file and adds a blog link to `/guide/api/authentication`. PR #105 has no changed-file overlap.
- Outcome: ⚠️ 1 error across 1 run (9m23s)

Pipeline

Updates from git push no-mistakes

✅ **intent** - passed

✅ No issues found.

✅ **Rebase** - passed

✅ No issues found.

✅ **Review** - passed

✅ No issues found.

⚠️ **Test** - 1 error
  • 🚨 .web/docs/guide/api/authentication.md - Target commit aa20a964… 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-target git diff inspection
  • Initial mise 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 --immutable
  • Retried mise exec node@24 -- corepack yarn check:docs && mise exec node@24 -- corepack yarn build
  • mise 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/.html forms of the five retired Developer API routes
  • chrome-devtools-axi browser checks and screenshots for the guide, AuthSession, and retired API route
  • rg scans of public source and generated output for retired links, navigation, authentication headers, JitPack/artifact guidance, generated stubs, endpoint-control claims, and sensitive-looking samples
  • gh-axi pr view and gh-axi pr diff --full for open PRs #103 and #105
  • Final mise 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.

@robinbraemer
robinbraemer merged commit 9a39076 into main Jul 13, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant