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 index.rst #16168

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update index.rst #16168

wants to merge 2 commits into from

Conversation

hanlaman
Copy link

Use ellipses consistently in menu items and commands #16025

Updated the JupyterLab documentation to mention Apple's Human Interface Guidelines for menus' style improvements.

References

Code changes

User-facing changes

Backwards-incompatible changes

Use ellipses consistently in menu items and commands jupyterlab#16025

Updated the JupyterLab documentation to mention Apple's Human Interface Guidelines for menus' style improvements.
Copy link

Thanks for making a pull request to jupyterlab!
To try out this branch on binder, follow this link: Binder

Copy link
Member

@krassowski krassowski left a comment

Choose a reason for hiding this comment

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

Thank you for working on this!

I would suggest to move the added text from index to either:

Can you update the title of the PR to reflect the content (what does this PR change) rather than which files it edits?

Finally, I left a comment on the alert added. It does not render in the preview for me, I am not sure if we want to keep it but if we do let's use the native admonition.

Comment on lines +55 to +59
.. .. only:: html

<div class="alert alert-warning" role="alert">
<strong>Note:</strong> The following section provides guidelines for menu item labeling based on Apple's Human Interface Guidelines.
</div>
Copy link
Member

Choose a reason for hiding this comment

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

I am not sure if this should be an alert. It currently does not render at all:

image

If it should be a visible admonition, let's implement it using the native admonitions syntax, for example with .. note:

within your document.
.. note::
Markdown headings with a HTML tag that contains the class ``jp-toc-ignore`` will be ignored;
e.g. ``# Title <a class="jp-toc-ignore"></a>``.
Automatic section numbering will go through your Notebook and number your sections and

which render like this:

image

See https://jupyterlab.readthedocs.io/en/latest/user/toc.html

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.

None yet

2 participants