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.

Sign up for GitHub

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

Jump to bottom

Update index.rst #16168

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

Update index.rst #16168

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5549bc5
Update index.rst
hanlaman Apr 15, 2024
0ec82de
Merge branch 'main' into hanlaman-patch-1
hanlaman Apr 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,24 @@ See the sections below (and the top-level links above) for more information abou
extension/extension_dev
developer/contributing
privacy_policies

.. .. 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>
Comment on lines +55 to +59
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:

jupyterlab/docs/source/user/toc.rst

Lines 24 to 31 in 73a947d

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


Menu Item Labeling Guidelines
------------------------------

When labeling menu items in JupyterLab, consider the following guidelines to ensure clarity and consistency for users:

1. **Menu Items with Dialog Boxes:** Append an ellipsis (...) to menu items that pop up a dialog box to accept additional information. For example, "Save As..." or "Export Notebook As...".

2. **Menu Items with Immediate Action:** Omit the ellipsis from menu items that take immediate action without requiring additional input. For example, "Save" or "Close".

3. **Cascading Menus:** Cascading menus, such as "File > Save and Export Notebook As", should not have an ellipsis. However, submenu items within cascading menus that require additional information should have an ellipsis.

Adhering to these guidelines improves the user experience by clearly indicating when additional input is needed for an action. It also maintains consistency with Apple's design principles for menu labeling.

For more information on JupyterLab's interface and customization options, refer to the relevant sections in the documentation.