Update guides #1035
Update guides #1035
Conversation
edan-bainglass
force-pushed
the
guide-text
branch
from
812b077 to
a23ad8f
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1035 +/- ##
==========================================
- Coverage 68.98% 68.90% -0.08%
==========================================
Files 113 113
Lines 6764 6764
==========================================
- Hits 4666 4661 -5
- Misses 2098 2103 +5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
edan-bainglass
force-pushed
the
guide-text
branch
2 times, most recently
from
690e708 to
2423f64
Compare
edan-bainglass
force-pushed
the
guide-text
branch
2 times, most recently
from
8307f57 to
d796afc
Compare
| Plugin guides | ||
| ------------- | ||
|
|
||
| Plugin developers may introduce additional guides to the app. To do so, add the following key/value entry in your plugin's ``__init__.py`` file: |
There was a problem hiding this comment.
What about , "Plugin developers can enhance the user experience while using the app by introducing custom guides"
| "guides": <path-to-guide>, | ||
| } | ||
|
|
||
| where ``path-to-guide`` is the path (``Path`` object or absolute string path) to the directory containing the guide HTML files. |
There was a problem hiding this comment.
"Here, path_to_guide should be either a Path object or an absolute string path pointing to the directory that contains the guide HTML files."
| Guide order | ||
| ----------- | ||
|
|
||
| When naming your guide HTML documents, prefix the file name with ``#_``. The number ``#`` will determine the order in which the guides are displayed in the list. |
There was a problem hiding this comment.
"To control the display order of your guide HTML documents, prefix each file name with #_, where # is a number. This number will dictate the order in which the guides appear in the list."
|
Looks good to me , I just had suggestion , but everything looks ready. Feel free to discard suggestions |
|
Thanks @AndresOrtegaGuerrero. Note that this PR is on hold until we get the main guide text settled on with Giovanni and Carlo. We're meeting today to discuss this. |
edan-bainglass
force-pushed
the
guide-text
branch
from
d796afc to
42c8bc8
Compare
edan-bainglass
force-pushed
the
guide-text
branch
from
42c8bc8 to
57e0aa5
Compare
This PR discards placeholder guide drafts and updates the content of the primary guide draft.
Closes #979