docs: Apply style guide edits #8134
Merged
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
✅ Deploy Preview for determined-ui canceled.
|
rb-determined-ai
approved these changes
Oct 12, 2023
dzhu
reviewed
Oct 12, 2023
docs/interfaces/index.rst
Outdated
| @@ -3,7 +3,7 @@ | |||
| ####### | |||
|
|
|||
| .. meta:: | |||
| :description: Get links to info about Determined AI tools such as the CLI User Guide, Commands and Shells, WebUI, Jupyter Notebooks, TensorBoard, and Exposing Custom Ports. | |||
| :description: Get links to info about Determined tools such as the CLI User Guide, Commands and Shells, WebUI, Jupyter Notebooks, TensorBoard, and Exposing Custom Ports. | |||
There was a problem hiding this comment.
Capitalization, for a start:
Suggested change
| :description: Get links to info about Determined tools such as the CLI User Guide, Commands and Shells, WebUI, Jupyter Notebooks, TensorBoard, and Exposing Custom Ports. | |
| :description: Get links to info about Determined tools such as the CLI user guide, commands and shells, WebUI, Jupyter Notebooks, TensorBoard, and exposing custom ports. |
Though, going further, this is kind of weirdly phrased and I don't know if it really needs to just list out every single link on this page, so maybe change it entirely to this instead:
Suggested change
| :description: Get links to info about Determined tools such as the CLI User Guide, Commands and Shells, WebUI, Jupyter Notebooks, TensorBoard, and Exposing Custom Ports. | |
| :description: Get links to info about the different interfaces that can be used to interact with Determined. |
There was a problem hiding this comment.
cool, cool, i've added this change to #8100
tara-det-ai
force-pushed
the
docs/Apply-style-guide-edits
branch
from
2e78b5b
to
c125337
Compare
tara-det-ai
force-pushed
the
docs/Apply-style-guide-edits
branch
from
c125337
to
597e0eb
Compare
tara-det-ai
force-pushed
the
docs/Apply-style-guide-edits
branch
from
597e0eb
to
4126ae6
Compare
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.
Apply minor edits