flake8
passed.
JSHint
passed.
Update and improve docs for new changes in RB6.
Review Request #13299 — Created Oct. 4, 2023 and submitted
We have a lot of new UI and user experience changes in RB6, so it was
necessary to do an overview of the docs to make sure everything is up to date.
This change updates any screenshots that were affected by our UI changes, and
fleshes out some documentation for file attachments and review requests.Note: The screenshots in this change are not perfect and are just
placeholders. They should be replaced with new screenshots in a later
change.
Built the docs, made sure the new screenshots looked good, checked that all new
refs worked, and checked for spelling errors.
| Summary | ID |
|---|---|
| c40422ae82526d68db6539fc869acb4e0751774b |
| Description | From | Last Updated |
|---|---|---|
|
Let's add a comma before "then browse" |
 david
|
|
|
Extra blank line at the end of the file. |
 chipx86
|
|
|
Two blank lines here. |
chipx86
|
|
|
Two blank lines here. |
chipx86
|
|
|
For each new image, we should do the following: Set :width: <value> to help define a width for the image … |
chipx86
|
|
|
The --> was wrong before. It should just be ->. That'll get styled correctly. |
chipx86
|
|
|
This may be a good candidate for converting to numeric lists of steps, even though it's not a long list. … |
chipx86
|
|
|
Extra blank line at the end of the file. |
chipx86
|
- Commits:
-
Summary ID d6ae7c04f5341dd06ee8aa69ca72586dac52f00f 14749b25b68df773be84c95408c560ef24c97520 - Diff:
-
Revision 2 (+120 -60)
Checks run (2 succeeded)
flake8
passed.
JSHint
passed.
-
Thanks for going through this! Looks great. There's a few spacing/blank line nits, some suggestions for improving
.. image:, and just a content suggestion. -
-
-
-
For each new image, we should do the following:
- Set
:width: <value>to help define a width for the image element, which will then be used to constrain the image's bounding box in the generated docs (the height is taken care of for you). - Set
:alt:for accessible text. It should describe what's in the image for those who can't see it. Seedocs/releasenotes/6.0-beta-3.rstfor examples here.
- Set
-
-
This may be a good candidate for converting to numeric lists of steps, even though it's not a long list.
Any time we have multiple steps or options or concepts in one paragraph, it's a good candidate for breaking that up into a more scannable form. Bullet points or numeric lists are a good option when they're all related. When they're separate options, different paragraphs can be good.
That can be useful for people just scanning a page, especially if English isn't their first option. But also, Google actually rewards this sort of formatting, sometimes showing it as answers in search results (which promotes the page in the process).
-
- Change Summary:
-
- Added
:alt:and:sources:for new images. - Made numeric lists where I can.
- Did not add any
:width:to the images, and decided that the images in
this change will just be placeholders and should be replaced.
- Added
- Description:
-
We have a lot of new UI and user experience changes in RB6, so it was
necessary to do an overview of the docs to make sure everything is up to date. This change updates any screenshots that were affected by our UI changes, and fleshes out some documentation for file attachments and review requests. + + Note: The screenshots in this change are not perfect and are just
+ placeholders. They should be replaced with new screenshots in a later + change. - Commits:
-
Summary ID 14749b25b68df773be84c95408c560ef24c97520 c40422ae82526d68db6539fc869acb4e0751774b - Diff:
-
Revision 3 (+166 -62)
Checks run (2 succeeded)
flake8
passed.
JSHint
passed.