Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update style_guide.rst #472

Merged
merged 1 commit into from
Dec 11, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 30 additions & 7 deletions docs/source/team/style_guide.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
SEPALSTYLE
==========

SEPAL documentation style guide
-------------------------------
The SEPAL documentation style guide
-----------------------------------


*Learn the basics of* SEPALSTYLE *to help maintain writing that is useful, clear, concise, consistent and fluid*

Expand Down Expand Up @@ -215,6 +216,7 @@ Common words used to describe actions in the **SEPAL interface** include:
- open
- monitor
- pan
- press
- register
- save
- select (use instead of *click*, except when not appropriate)
Expand All @@ -240,6 +242,9 @@ Common words used to describe elements in the **SEPAL interface** include:
- button
- checkbox
- dash
- dashboard
- dialog
- dock
- drawer
- dropdown menu
- feature
Expand Down Expand Up @@ -282,7 +287,8 @@ Common words used to describe **elements** *and* **actions** in the **SEPAL inte
"bar","go to, view, select, monitor","View the **Status bar** to monitor the download progress."
"button","select","Select the **Terminal** button."
"checkbox","select","Select the **Display map** checkbox."
"dash","go to","Go to the **SEPAL dash**."
"dashboard", "go to", "Open the **Apps** dashboard."
"dialog", "view, select", "Select **Confirm** in the dialog."
"dock","select","Select the **Files** tab in the dock."
"drawer","open, close","Open the **Navigation** drawer."
"dropdown menu","open, select, choose","Select **Vector file** from the dropdown menu."
Expand Down Expand Up @@ -440,6 +446,23 @@ Hyphens can be used: for compound adjectives, when describing ages, amounts or l

High-quality data for 15 year-old forests.

Parentheses and brackets
""""""""""""""""""""""""

Parentheses are used to include less important text in a sentence or to enclose descriptive information.

When only part of a sentence is enclosed in parentheses, punctuation is placed outside.

**Example**

Open the **Optical mosaics** recipe (for more information, see figure below and https://docs.sepal.io/en/latest/cookbook/optical_mosaic.html).

When a complete sentence is enclosed in parentheses, its punctuation is also enclosed.

**Example**

(You should see an interface like in the following figure.)

Quotation marks
"""""""""""""""

Expand Down Expand Up @@ -477,10 +500,10 @@ Highlights

Common terms for showcasing information include:

- Tip
- Note
- Attention
- Important
- **Attention**: To be used to showcase *extremely important* information.
- **Important**: To be used to showcase *moderately important* information.
- **Note**: To be used to showcase *important* information.
- **Tip**: To be used to showcase *helpful* information.

Avoid "Warning" and "Danger".

Expand Down