Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
stockholmux opened this issue May 30, 2024 · 5 comments · Fixed by #153
Closed

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

stockholmux opened this issue May 30, 2024 · 5 comments · Fixed by #153

Comments

@stockholmux
Copy link
Member

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
Copy link
Contributor

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.

zuiderkwast added a commit to zuiderkwast/valkey-doc that referenced this issue Jul 3, 2024
…ors, valkey-io#127

Refactor the sections about various kinds of nulls.

Signed-off-by: Viktor Söderqvist <[email protected]>
@zuiderkwast
Copy link
Contributor

@stockholmux This page is still not visible on the website. Does it still have issues?

@stockholmux
Copy link
Member Author

stockholmux commented Dec 9, 2024

@zuiderkwast Indeed there is a problem. The content looks generally fine but there is something weird going on with the file, when I remove the file from the publishing hold it renders like this:

Screenshot 2024-12-09 at 8 38 07 AM

The weird single bullet seems to be related to some sort of errant character somewhere in the frontmatter section. It also blows up my markdown linter in vscode (note the related errors shown while mousing over the errors don't seem to be describing anything useful: MD041, MD022):

Screenshot 2024-12-09 at 8 40 10 AM

When I manually remove the frontmatter in the source file and re-write it there it renders fine:

Screenshot 2024-12-09 at 8 42 36 AM

It's quite weird really; none of the other topics have this problem. I don't see a tab character anywhere but that would be my first guess; the fix should be easy - just remove the existing frontmatter and re-enter it cleanly.

@zuiderkwast
Copy link
Contributor

Thanks for the hint! Now I've spotted something: The frontmatter starts with 3 dashes and ends with 4 dashes.

Can that be it?

@stockholmux
Copy link
Member Author

Gosh! I didn't notice the extra dash but that'll do it!

zuiderkwast added a commit to zuiderkwast/valkey-doc that referenced this issue Dec 10, 2024
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 a pull request may close this issue.

2 participants