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

Unify project name as "Liquid Prompt" in docs (spelled as two words) #677

Merged

Conversation

ottok
Copy link
Contributor

@ottok ottok commented Jun 28, 2021

On the front page README.md the project name is spelled "Liquid Prompt" as two words. This PR suggests to use that spelling across all project documentation.

@Rycieos
Copy link
Collaborator

Rycieos commented Jun 28, 2021

In my opinion, I think it makes sense as one word. The project ID is also one word; if it was two words, I would think it would be liquid-prompt. I would rather see any instances of "Liquid prompt" changed to "Liquidprompt" than this.

But @nojhan named it originally, so what would you like to see?

@augmentedfourth
Copy link
Contributor

Also note that the package name in homebrew (and I think other distribution mechanisms) is a single word, un-capitalized... just like the file name of the script itself. I'll defer to @nojhan as well, but as someone who's used this tool for over a decade "Liquid Prompt" just looks jarring.

@nojhan
Copy link
Collaborator

nojhan commented Jun 28, 2021

That's a though question. Do someone have access to some SEO tools to check which name leads to the largest search engine share (out of existing hits)?

@Rycieos
Copy link
Collaborator

Rycieos commented Jun 28, 2021

Do someone have access to some SEO tools to check which name leads to the largest search engine share

I'm no SEO expert, but some quick digging leads to the following:

  1. "Liquid prompt" has more than 10 times the "hits" than "Liquidprompt" does, but that is not a fair comparison. The space means it is two separate search terms, and you get a ton of false positive hits.
  2. "Liquid prompt" hits mostly on blog posts about the project (so many blog posts, wow).
  3. "Liquidprompt" hits mostly on documentation and packaging indexes.
  4. "Liquidprompt" hits on pages with only the string "Liquid prompt" in the page.

Based on this, I think:

  • Because of 4, searching with the string "liquidprompt" will hit both forms, while "liquid prompt" won't always.
  • Documentation is probably the first thing we want users to find.
  • Because of 1, we don't want users to find unrelated pages.

I think that "Liquidprompt" is better for SEO.

@nojhan
Copy link
Collaborator

nojhan commented Jun 29, 2021 via email

@ottok
Copy link
Contributor Author

ottok commented Jun 29, 2021

I'll wait for a week for further feedback and if this is the decision, I'll revert the PR to do the change for all current Liquid Prompt into Liquidprompt.

@dolmen
Copy link
Collaborator

dolmen commented Jul 1, 2021

As someone who has contributed to this mess, my preference was Liquid Prompt as the project name and liquidprompt as the command to invoke it.

But as a former maintainer, consider my vote as neutral if votes are involved.

@ottok ottok force-pushed the docs/unified-project-name-spelling branch from 9d51b12 to 4214b44 Compare July 18, 2021 03:25
@ottok
Copy link
Contributor Author

ottok commented Jul 18, 2021

When looking at pages that Google finds on "liquidprompt" they are all pages that reference the package name, not the project name. As soon as you start to get results about blog posts that decribe the project, everybody seem to write about "Liquid Prompt" – two separate words, and both capitalized. I agree with that and I think it is also better English (though I am not a native speaker). One of the search results with "liquidprompt" even yields "Liquid Prompt", because that blog post is so popular.

Thus, I leave my PR leaning on "Liquid Prompt".

image

vs

image

@ottok
Copy link
Contributor Author

ottok commented Jul 18, 2021

I also checked Google Trends. The name "Liquid Prompt" is more popular than spelled together, but the search volume is so low that the difference is not significant.

image

@Rycieos
Copy link
Collaborator

Rycieos commented Jul 29, 2021

Sorry for the radio silence on this. I'm not sure what the path forward should be, since we have a few on each side of the camp, and @nojhan seems to be fine either way. Ideally we would get some other opinions on this, but I realize that leaving this sitting open forever is not ideal either.

@Rycieos Rycieos added documentation reviews wanted Looking for reviews from the community labels Jul 29, 2021
@ottok
Copy link
Contributor Author

ottok commented Jul 29, 2021 via email

@nojhan
Copy link
Collaborator

nojhan commented Aug 22, 2022

Looking at the search engine results, I think "Liquid Prompt" would better match what the actual users are using to refer to the project.

This is a key point in my opinion, because we are facing competitors that have less interesting features and design, and still surprisingly seem to be more popular. We definitely need to reach the users in their own words.

Also, it emphasizes one of the key feature of the design, which is to actually be liquid. It is probably worth it to use the adjective as a keyword, and I think having it separated helps. One could even use "the Liquid Prompt", so as to emphasize even more.

It doesn't seem like a big deal to have the command/repository keeping the one-word version, I think most of people would understand, especially if the official website use the two-words version.

@nojhan nojhan mentioned this pull request Aug 22, 2022
Copy link
Collaborator

@Rycieos Rycieos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, sounds like a close enough consensus then. I agree, let's unify the name.

@ottok, if you could fix these small issues I've pointed out, and maybe squash and rebase, I'll merge this in.

docs/theme/included/powerline.rst Outdated Show resolved Hide resolved
docs/theme/included/powerline.rst Outdated Show resolved Hide resolved
docs/theme/included/alternate_vcs.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/config.rst Outdated Show resolved Hide resolved
@ottok
Copy link
Contributor Author

ottok commented Aug 22, 2022 via email

As per discussion in PR#677, the project slug and command name remains as
'liquidprompt' but in human language it looks better to spell it as
'Liquid Prompt' and that is in fact already widely used when referencing
this project when looking at blog posts and similar on the web today.
@ottok ottok force-pushed the docs/unified-project-name-spelling branch from 4214b44 to 1b1e023 Compare August 23, 2022 05:52
@ottok ottok requested a review from Rycieos August 23, 2022 05:53
@ottok
Copy link
Contributor Author

ottok commented Aug 23, 2022

Fixed all items commented and rebased on latest master.

Copy link
Collaborator

@Rycieos Rycieos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ottok!

@Rycieos Rycieos removed the reviews wanted Looking for reviews from the community label Aug 23, 2022
@Rycieos Rycieos merged commit 977d91a into liquidprompt:master Aug 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants