-
Notifications
You must be signed in to change notification settings - Fork 196
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
DOC: index <title> tag just says "Overview" #721
Comments
Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗 |
Is there a |
Thanks for the pointer @westurner, how does #721 look? https://myst-parser--722.org.readthedocs.build/en/722/index.html |
On modern (especially mobile) browsers we only have a few characters to
differentiate between tabs
- "Overview"
- "MyST Parser Overview"
- "MyST Parser Intro"
- "MyST Parser Core Syntax"
So the prefix of the tab is most relevant in distinguishing between tabs;
- "Overview | MyST-Parser Documentation"
- "Intro | MyST-Parser Documentation"
- "Core Syntax | MyST-Parser Documentation"
- "Core Syntax | MyST-Parser Documentation"
- "Core Syntax < Guides | MyST-Parser Documentation"
Are there breadcrumbs from sphinx or jupyter-book.
Sphinx includes the word "Documentation" in the title tags IIRC. That
probably also matches "docs"? So that "myst parser docs" finds the correct
page
…On Sat, Feb 25, 2023, 11:16 AM Chris Sewell ***@***.***> wrote:
Thanks for the pointer @westurner <https://github.com/westurner>, how
does #721 <#721>
look? https://myst-parser--722.org.readthedocs.build/en/722/index.html
—
Reply to this email directly, view it on GitHub
<#721 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAAMNS5GNZKLNJZ7ALODUC3WZIV6FANCNFSM6AAAAAAVHCDI7M>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Sorry I'm a little confused by what you are after here 😅 Should I prepend "| MyST Parser", to all titles, rather than append? Or maybe you can you give some specific examples, of what you would like to see appear in the html? |
I'd note myst-parser has no dependence on jupyter-book (it's the other way around) |
Describe the bug
context
<title>
tags for the docs could have a suffix that includes e.g. "| MyST-Parser Documentation" for searchabilityexpectation
I expected to: have more than "Overview" to visually identify and textually search for the myst-parser docs tab.
bug
But instead: it just says "Overview"
problem
This is a problem for people doing ___ because ___.
Reproduce the bug
List your environment
No response
The text was updated successfully, but these errors were encountered: