search

valkey-io / valkey-doc

Other
17 stars 25 forks source link

`/topics/protocol.md` needs work: naming, links, and malformed HTML #127

Closed stockholmux closed 3 days ago

stockholmux commented 1 month ago

In pre-publishing review (#91), I found several issues on /topics/protocol.md

"Valkey serialization protocol specification" title

Drop "Valkey"

While the protocol was designed specifically for Valkey, you can use it for other client-server software projects.

It wasn't designed specifically for Valkey. Refactor.

Support for the first version of the RESP protocol was introduced in Redis OSS 1.2. Using RESP with Redis OSS 1.2 was optional and had mainly served the purpose of working the kinks out of the protocol.

This isn't relevant for Valkey/2024.

The RESP3 Push type.

Links to a hash that doesn't exist.

<a name="boolean-reply">

The a tag isn't closed causing the entire section to become an unclickable link.

Screenshot 2024-05-30 at 1 21 46 PM

<a name="verbatim-string-reply">

The a tag isn't closed causing the entire first line to become an unclickable link

Screenshot 2024-05-30 at 1 24 46 PM

zuiderkwast commented 2 weeks ago

Drop "Valkey" "was designed specifically for Valkey"

I'll drop, refactor, etc. as appropriate.

Support for the first version of the RESP protocol was introduced in Redis OSS 1.2. Using RESP with Redis OSS 1.2 was optional and had mainly served the purpose of working the kinks out of the protocol.

This isn't relevant for Valkey/2024.

I'll refactor/minify. (It's of some historical interest.)

<a name="boolean-reply">

I'll delete all these manually added anchors and update all links to these sections, from this and other pages, to the correct ones.