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

Update About page -> How it works #174

Closed
wants to merge 1 commit into from
Closed

Update About page -> How it works #174

wants to merge 1 commit into from

Conversation

ericholscher
Copy link
Member

@ericholscher ericholscher commented Nov 25, 2022

This makes it a bit more obvious what the page is about,
and isn't confused with the About us page.

Already put in a redirect:

Screenshot 2022-11-25 at 9 07 42 AM


📚 Documentation preview 📚: https://read-the-docs-site-community--174.com.readthedocs.build/en/174/

This makes it a bit more obvious what the page is about,
and isn't confused with the `About us` page.
@ericholscher ericholscher requested a review from a team as a code owner November 25, 2022 17:07
Copy link
Contributor

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

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

I'm more impartial on the name of the page. "About" seems fine as the target page is serving two purposes -- feature list and explaining how RTD works.

I'd suggest not using "How it Works" and instead call the page "Overview", "Features" (though this page is more than features), or "Product" (though I hate this pattern in general for being incredibly unclear). I'd probably lean "Overview".

I proposed putting this under a dropdown, so we can be more wordy with navigation entries. We likely want to link other pages as well, which I why I haven't bothered changing this page title yet.

@@ -1,5 +1,5 @@
{% macro menu_main() %}
<a class="item{% if page and page.slug == 'about' %} active" aria-current="page{% endif %}" href="{{ SITEURL }}/about/">About</a>
<a class="item{% if page and page.slug == 'about' %} active" aria-current="page{% endif %}" href="{{ SITEURL }}/how-it-works/">How it works</a>
Copy link
Contributor

Choose a reason for hiding this comment

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

"How it Works" doesn't look good enough for me to want to break the pattern of single word entries in the top navigation. The website has a few entries right now, but I'd like more, and the application will have more top navigation entries.

@ericholscher
Copy link
Member Author

ericholscher commented Nov 28, 2022

@agjohnson I'm confused, since you suggested the exact opposite on Slack: https://readthedocs.slack.com/archives/C1VM2ENUB/p1668462658520369 -- I originally suggested Product Overview, which I think is the right framing.

I'd just like to get this change out since the current implementation is confusing, so are you 👍 with Overview and we can iterate on a larger menu later?

@agjohnson
Copy link
Contributor

My suggestion in that conversation was to put verbose options in a dropdown menu, which is in line with my suggestion above. Guessing this is missing from the context, as I thought you agreed with my suggestion for the dropdown in that conversation 🤷

so are you +1 with Overview and we can iterate on a larger menu later?

I mean, I don't share the priority on renaming the about page, so no. I would replace the top navigation with a dropdown first, which is what I described in that conversation:

https://readthedocs.slack.com/archives/C1VM2ENUB/p1668462728477219

Thinking farther ahead, "Overview" is okay title for the about page, but I wouldn't reuse "Overview" for a dropdown later. So this would be a bad half-step. As a navigation link to a page, "Product" is horribly unclear -- it doesn't describe what to expect at all. But, as a dropdown, "Product" works better than other options, as these page links will be verbose submenu entries inside the dropdown anyways.

So to clarify, I would:

  • Not rename the about page yet
  • Replace the "About" top navigation menu with a "Product" dropdown
  • Move the "about" page to "product/how-read-the-docs-works" and add a submenu item in the "Product" dropdown for "How Read the Docs works"
  • Finally add necessary redirects

If you feel like managing this change and redirects twice, you can rename "about" to "product". Without the dropdown, this is a lateral move though, and doesn't seem any clearer. So seems like wasted effort.

@ericholscher
Copy link
Member Author

OK. I will close this then, and wait for you to do a dropdown 👍

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