2. In the Rust SDK, the sidebar includes a surrealdb/rust label which seems confusing as there is no rust repository. The link is, however, correct (it points to surrealdb/surrealdb). Image showing the issue:
3. In the Golang Overview page (https://surrealdb.com/docs/sdk/golang), the following sentence appears a bit confusing "For more information about the SurrealDB Go SDK API, see the documentation". In fact, this sentence is already included in the Golang SDK documentation.
Proposed fixes
For the problems described in 1.,
A possible approach could be to remove "here" and mention the repository directly.
Example for Java:
Replace "submit an Issue or Pull Request here" with "submit an Issue or Pull Request in the surrealdb.java repository"
Also, instead of "edit this file on GitHub", something like "submit an Issue or Pull Request in the docs.surrealdb.com repository" (or similar) could be considered. In fact, the doc, when built and uploaded online, will already include the correct link to edit the file in GitHub, as show in the image below:
Ekwuno
commented
1 month ago
Description
Hi! Reporting below a few issues.
1. There are two missing links ("this" and "here") in multiple SDK 'Overview' pages, as show in the picture below:
This problem affects the following SDK:
Ref (for Python, as an example of the issue):
2. In the Rust SDK, the sidebar includes a
surrealdb/rustlabel which seems confusing as there is norustrepository. The link is, however, correct (it points tosurrealdb/surrealdb). Image showing the issue:Ref:
3. In the Golang Overview page (https://surrealdb.com/docs/sdk/golang), the following sentence appears a bit confusing "For more information about the SurrealDB Go SDK API, see the documentation". In fact, this sentence is already included in the Golang SDK documentation.
Proposed fixes
For the problems described in 1.,
Example for Java:
Replace "submit an Issue or Pull Request here" with "submit an Issue or Pull Request in the
surrealdb.javarepository"Also, instead of "edit this file on GitHub", something like "submit an Issue or Pull Request in the
docs.surrealdb.comrepository" (or similar) could be considered. In fact, the doc, when built and uploaded online, will already include the correct link to edit the file in GitHub, as show in the image below:For the problem described in 2.,
For the problem described in 3.,
PR is coming with the proposed fixes.
In the hope this helps, Thanks!
Is there an existing issue for this?
Code of Conduct