Skip to content

Commit 7b4e2a5

Browse files
committed
Minor documentation fixes.
1 parent 95dfff7 commit 7b4e2a5

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

context/documentation-guidelines.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Every feature or concept should be introduced with clear context about why users
7373
1. **Problem statement**: What challenge does this solve?
7474
2. **Use cases**: When would users encounter this need?
7575
3. **Solution overview**: How does this feature address the problem?
76-
4. **Implementation**: Code examples and detailed usage
76+
4. **Implementation**: Code examples and detailed usage.
7777
7878
#### Example
7979
@@ -129,7 +129,7 @@ When documenting advanced features, follow this structure:
129129
4. **Best Practices**: When to use vs when not to use
130130
5. **Common Pitfalls**: What to watch out for
131131

132-
#### Template
132+
#### Template
133133

134134
```markdown
135135
## [Feature Name]
@@ -237,13 +237,15 @@ Help users understand when to choose between alternatives:
237237

238238
Every code example should demonstrate a realistic scenario, not abstract operations:
239239

240-
**Abstract**:
240+
❌ Abstract:
241+
241242
```ruby
242243
client.set("key", "value")
243244
client.get("key")
244245
```
245246

246-
**Contextual**:
247+
✅ Contextual:
248+
247249
```ruby
248250
# Store user session data:
249251
client.set("session:#{session_id}", user_data.to_json)

guides/documentation-guidelines/readme.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -237,13 +237,15 @@ Help users understand when to choose between alternatives:
237237

238238
Every code example should demonstrate a realistic scenario, not abstract operations:
239239

240-
**Abstract**:
240+
❌ Abstract:
241+
241242
```ruby
242243
client.set("key", "value")
243244
client.get("key")
244245
```
245246

246-
**Contextual**:
247+
✅ Contextual:
248+
247249
```ruby
248250
# Store user session data:
249251
client.set("session:#{session_id}", user_data.to_json)

0 commit comments

Comments
 (0)