Tutorials: Improve guidance within article header sections #64
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
amotl
commented
Mar 12, 2024
Comment on lines
+59
to
+63
| :ts: Timestamp when each reading was taken. | ||
| :device_id: Identifier of the device. | ||
| :battery: Object containing battery level, status, and temperature. | ||
| :cpu: Object containing average CPU loads over the last 1, 5, and 15 minutes. | ||
| :memory: Object containing information about the device's free and used memory. |
There was a problem hiding this comment.
Funny how battery is colored red?
There was a problem hiding this comment.
No idea, is it some keyword by chance?
proddata
approved these changes
Mar 13, 2024
marijaselakovic
approved these changes
Mar 13, 2024
amotl
force-pushed
the
amo/tutorials-guidance
branch
from
9ab46f9
to
8a6063e
Compare
- Introductory explainers / What's inside To give a better overview about the actual features used within the tutorial. - Guidance and layout In order not to use too much vertical space for the header information, use a two-column micro layout where applicable. For a better visual appearance where enumerating the tables' columns in detail, use field lists [1,2]. [1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#field-lists [2] https://myst-parser.readthedocs.io/en/latest/syntax/typography.html#field-lists
amotl
force-pushed
the
amo/tutorials-guidance
branch
from
8a6063e
to
962f28b
Compare
HTTPSConnectionPool(host='azure.microsoft.com', port=443): Read timed out. (read timeout=5)
HTTPSConnectionPool(host='hub.docker.com', port=443): Read timed out. (read timeout=5)
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.
What's Inside
Introductory explainers / What's inside
To give a better overview about the actual features used within the
tutorial(s).
Guidance and Layout
In order not to use too much vertical space for the header
information, use a two-column micro layout where applicable.
For a better visual appearance where enumerating the tables' columns
in detail, use field lists [1,2].
[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#field-lists
[2] https://myst-parser.readthedocs.io/en/latest/syntax/typography.html#field-lists
Preview
https://crate-cloud--64.org.readthedocs.build/en/64/tutorials/
Highlights
Demonstrating how even micro layouts using new Sphinx design features, other applications of less popular Sphinx baseline features, and tuning down verbatim formatting, can make a significant difference on matters of reader guidance and overall appearance, for people who like it.
Trivia
Other than the main changes outlined above, the patch also: