DEVPROD-5307: Documentation for Parsley Sectioning #8346
Merged
+36
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
minnakt
approved these changes
Oct 4, 2024
docs/UI/Parsley-Sectioning.md
Outdated
Comment on lines
17
to
19
| Clicking on the caret will also open and close a single command or function section. | ||
|
|
||
|  |
There was a problem hiding this comment.
I think you can omit this image (since it looks kinda odd just having the image of the caret) and just say
Suggested change
| Clicking on the caret will also open and close a single command or function section. | |
|  | |
| The caret on the left-hand side can also be used to open or close a single command or function section. |
which the reader can infer from the picture directly above
docs/images/section_toggle.png
Outdated
There was a problem hiding this comment.
(can delete this file I think)
| Sections that contain a search result will open. Iterating over search results will open the section if it's closed. | ||
|
|
||
| ### Filtering | ||
| Sections will temporarily go away when filters are applied and come back when filters are removed. |
There was a problem hiding this comment.
(or something along these lines)
Suggested change
| Sections will temporarily go away when filters are applied and come back when filters are removed. | |
| Sectioning cannot be used in conjunction with filters. Sections will not render when filters are applied, but will reappear when all filters are removed. |
Comment on lines
+37
to
+38
| ### Shareline | ||
| When a link with a share line is opened, Parsley will open the section that contains the share line and scroll to the line. The failing line section will still open but Parsley will scroll to the share line instead. |
There was a problem hiding this comment.
Suggested change
| ### Shareline | |
| When a link with a share line is opened, Parsley will open the section that contains the share line and scroll to the line. The failing line section will still open but Parsley will scroll to the share line instead. | |
| ### Share Line | |
| Share line takes precedence over failing line. When a link with a share line is opened, Parsley will open the section that contains the share line and scroll to the line. The failing line section will still be open and accessible via the bookmarks bar. |
| ## Overview | ||
| Parsley sectioning is toggleable from the "Log Viewing" tab of the "Parsley Settings" menu and is available to task logs only. Toggling the feature will render your task log into expandable sections split up by function and command. | ||
|
|
||
| ## Feature details |
There was a problem hiding this comment.
nit. Would just recommend double checking if you want these headers in title case or in sentence case since it's slightly inconsistent (e.g. Section status vs Jump to Failing Line)
There was a problem hiding this comment.
Good one. I'll stick to sentence case.
Co-authored-by: minnakt <47064971+minnakt@users.noreply.github.com>
Co-authored-by: minnakt <47064971+minnakt@users.noreply.github.com>
Co-authored-by: minnakt <47064971+minnakt@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DEVPROD-5307
Description
These code changes introduce documentation for the Parsley sectioning feature.