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

Extra valkey in title #169

Closed
wants to merge 2 commits into from

Conversation

stockholmux
Copy link
Member

@stockholmux stockholmux commented Nov 27, 2024

Description

In valkey-io/valkey-doc#164 @zuiderkwast pointed out that 'Valkey ' was repeated needlessly in the doc titles, leading to silly titles like "Valkey Documentation · Valkey Functions".

This issue resolves the concern by removing "Valkey " from the titles headings on the alphabetical list.

It smartly recapitalizes the first letter of the title so, for example, a title of "Valkey functions" renders as "Functions" in the alpha list, "Documentation: Functions" in the subhead, and "Valkey Documentation · Functions" in the HTML head title tag.

Issues Resolved

n/a

Check List

  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License.

Signed-off-by: Kyle J. Davis <[email protected]>
@zuiderkwast
Copy link
Contributor

Can't we remove it from each file in the doc repo instead?

@zuiderkwast
Copy link
Contributor

If we remove it programatically like this, maybe it makes sense now, but if someone writes a title like "Valkey as a cache" the grammar will break as "Valkey Documentation: As a cache".

@stockholmux
Copy link
Member Author

@zuiderkwast If you want to remove it from the source documents, that's fine. My understanding was that you needed for your purpose somehow.

WRT the grammar breaking: yeah, that's a risk. There is a way to catch that on this side via frontmatter override, but it is more optimal to just not have double valkey.

@zuiderkwast
Copy link
Contributor

I'll remove it from the titles in the doc repo then, unless you do it first.

I don't need it. The man pages have a similar header that say "valkey documentation" or similar, so it is redundant there too.

@zuiderkwast
Copy link
Contributor

valkey-io/valkey-doc#193

@stockholmux
Copy link
Member Author

Issue resolved by valkey-io/valkey-doc#193

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 this pull request may close these issues.

2 participants