Skip to content

Commit 9b24d0c

Browse files
authored
Add numbering to some diagrams, update README to include guidance on diagrams (#436)
1 parent 6400fb2 commit 9b24d0c

File tree

3 files changed

+3
-0
lines changed

3 files changed

+3
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Keep the following principles in mind:
5353
- **Write in clear, concise language**, using [active voice](https://developers.google.com/style/voice) whenever possible. Keep sentences and paragraphs short and to the point. Be conversational and friendly tone. Stay away from jargon as much as you can.
5454
- **Use [Fern’s documentation components](https://buildwithfern.com/learn/docs/writing-content/components/overview)** whenever you can.
5555
- **When editing an existing page** - Match the existing heading structure, tone, and level of detail to ensure your changes integrate as seamlessly as possible.
56+
- **Use diagrams when it makes sense** – Show, don't tell! Use [Mermaid](https://buildwithfern.com/learn/docs/writing-content/markdown#diagrams), a Markdown-like diagramming syntax, to illustrate a workflow.
5657

5758
> "Break any of these rules sooner than say anything outright barbarous."
5859
>

fern/products/docs/pages/authentication/sso.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Fern's SSO integration allows your team to use their existing corporate credenti
2222

2323
```mermaid
2424
sequenceDiagram
25+
autonumber
2526
participant U as User
2627
participant F as Fern Docs
2728
participant I as Identity Provider

fern/products/docs/pages/enterprise/self-hosted.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Fern provides your documentation site as a ready-to-run Docker container that yo
4141

4242
```mermaid
4343
sequenceDiagram
44+
autonumber
4445
participant F as Fern
4546
participant C as Customer
4647
participant S as Customer Server

0 commit comments

Comments
 (0)