docs: fix broken /v1 endpoint links in tutorials & reference - #178
Merged
johnymontana merged 1 commit intoAug 11, 2026
Merged
Conversation
The bare production URL https://memory.neo4jlabs.com/v1 404s when visited in a browser, but AsciiDoc auto-links any bare URL — even inside backtick monospace — into a clickable `<a>`. Every inline `https://memory.neo4jlabs.com/v1` in the docs therefore rendered as a clickable 404 (reported on the TypeScript tutorials). The API genuinely lives under /v1 (the SDK selects REST transport only when the endpoint matches /v\d+/), so /v1 must stay in the documented base URL and SDK endpoint values — the fix is to stop the inline mentions from linking, not to strip /v1. - Tutorial prose pointers ("hosted service at …", "API key for …") now link to https://memory.neo4jlabs.com/ (a valid landing page). - Reference/how-to mentions where /v1 is the documented API base keep /v1 via the `+...+` passthrough so they render as non-clickable monospace. - Code-block and curl values under [source] are unchanged (never auto-linked). Fixes neo4j-labs/project-nams#192 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
@rafaljanicki is attempting to deploy a commit to the lyonwj's projects Team on Vercel. A member of the Team first needs to authorize it. |
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
Contributor
Author
johnymontana
approved these changes
Aug 11, 2026
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
3 participants
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.
Problem
Reported by Erik Bijl (neo4j-labs/project-nams#192): the link
https://memory.neo4jlabs.com/v1renders as a clickable 404 on the published tutorials (e.g. first-agent-memory-typescript and hosted-quickstart-typescript).Root cause: AsciiDoc auto-links any bare URL — even inside backtick monospace — into an
<a class="bare">. Visiting the barehttps://memory.neo4jlabs.com/v1returns 404, so every inline mention became a broken clickable link. This affected 9 spots across 9 pages, not just the two tutorials Erik happened to notice.Why not just strip
/v1everywhereThe API genuinely lives under
/v1:https://memory.neo4jlabs.com/v1/conversations→ 401 (route exists), buthttps://memory.neo4jlabs.com/conversations→ 404.pickTransportselects REST mode only when the endpoint matches/\/v\d+\b/— so/v1in the documentedMEMORY_ENDPOINTdefault and SDKendpointvalues is load-bearing.Blanket-replacing
/v1with/would make the reference docs factually wrong. So the fix stops the inline URLs from linking, rather than removing/v1.Changes
https://memory.neo4jlabs.com/(a valid landing page, 200)./v1is the documented API base keep/v1via the+…+passthrough, so they render as non-clickable monospace (same idiom already used inreference/deployment.adoc).[source]are unchanged — AsciiDoc never auto-links those, and they must keep/v1.Verified: no backtick-wrapped bare
/v1remains linkable; the 17 code-block/curl/v1values are preserved.Fixes neo4j-labs/project-nams#192