Documentation Searchability

[garymoon]

Hi DC team,

I'm using @deltachat/napi-jsonrpc. I understand after a little bit of sleuthing that the relevant docs are at https://js.jsonrpc.delta.chat/classes/RawClient.html, but they don't seem to be indexed by Google. If I search for "miscSendMsg" there's only one result from the changelog. As to why this is, nothing jumps out at me from devtools and lighthouse doesn't complain either :man_shrugging: Perhaps Google Search Console might provide some insights.

There is also a similar problem within the Github org, where if I search for "miscSendMsg" there's again only one result from the changelog. Perhaps generated code and docs could be pushed to their respective repos at build time to aid searchability.

Big ups for putting together the cosmos :space_invader: And thanks for DeltaChat :blue_heart:

[link2xt]

I'm using @deltachat/napi-jsonrpc.

Not related directly to the issue, but napi-jsonrpc is archived: https://github.com/deltachat/napi-jsonrpc I suggest that you switch to using @deltachat/jsonrpc-client and @deltachat/stdio-rpc-server directly. This is what Delta Chat Desktop is using. You can look at nodejs_stdio_jsonrpc in https://github.com/deltachat-bot/echo/ or https://github.com/link2xt/xdcterm/ for an example.

[garymoon]

Thanks @link2xt, I saw that while tracking down the napi docs, but was going to go for an if-it-ain't-broke approach. Bad move? :sweat_smile:

Edit: Also not directly related, but thanks for https://github.com/link2xt/xdcterm/ :blue_heart: The echo bot was how I found out about the newer api, but it's not a complete enough implementation to give one an idea of the scope of change.

[link2xt]

It should be easy to port if you already started with napi, JSON-RPC API is the same. The difference is that stdio approach is simply starting deltachat core as a subprocess and communicates with it over standard input and standard output, while napi runs the core in the same process and requires Node.js addon built with https://napi.rs/.

Every time we tag a new core release, new @deltachat/stdio-rpc-server is published, but https://npm.io/package/@deltachat/napi-jsonrpc is stuck at v0.101.1 published two years ago.

I opened https://github.com/deltachat-bot/echo/pull/72 to remove old examples.

[garymoon]

Ooooh, thank you for the clarification, I've caught a mistake. I have a project using the go client which takes the stdio approach, and I'd conflated them. I was thinking stdio-rpc-server was a second iteration of the same approach, but I see now I'm wrong. I'll test out and do the upgrade soon, thank you mate :blue_heart:

[Simon-Laux]

you can already search on the documentation site: https://js.jsonrpc.delta.chat

There is no robots.txt and no sitemap.xml, maybe the latter is required for google indexing. We may need to update typedoc and file an issue on https://github.com/TypeStrong/typedoc/issues, because that's the documentation generator we use.

[Simon-Laux]

Perhaps Google Search Console might provide some insights.

not really, besides missing sitemap. Probably also bad SEO.

[r10s]

seems, the site is at least now indexed by google as well as by duckduckgo - searching for site:js.jsonrpc.delta.chat gives quite some results.

also the initial example, searching miscSendMsg shows a result on google now, not the first, but well.

apart from that, we are not into SEO, let alone for google. so i do not see another actionable item here - thanks all for helping :)