Skip to content

Add back-to-top navigation to REFERENCE.md #16

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.

Sign up for GitHub

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

Merged
serradura merged 3 commits into from
Jan 29, 2026
Merged

Add back-to-top navigation to REFERENCE.md #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e8df9dd
Add Quick Overview link to Start Learning section
serradura Jan 29, 2026
9d3ec34
Add back-to-top navigation anchors to REFERENCE.md
serradura Jan 29, 2026
47b4437
Document back-to-top anchor convention in CLAUDE.md
serradura Jan 29, 2026
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
7 changes: 7 additions & 0 deletions .claude/CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
- **[docs/REFERENCE.md](docs/REFERENCE.md)** — Comprehensive guide covering every feature with detailed examples. Point AI coding agents here.
- **[docs/overview/](docs/overview/)** — Quick overview guides (010–100) for each topic.

### Back-to-Top Anchors

Both `README.md` and `docs/REFERENCE.md` use back-to-top navigation after each main section. When adding a new numbered section to `REFERENCE.md`:

1. Add `<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>` before the `---` that closes the section
2. Update the Table of Contents with the new entry

## Common Commands

```bash
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ You can also check the [examples](examples) directory for more simple examples o

> **🤖 AI Agents:** Point your coding assistant to [`docs/REFERENCE.md`](docs/REFERENCE.md) for complete API knowledge and patterns, or explore the [AI-Powered Wiki](https://deepwiki.com/solid-process/solid-process) for visual diagrams and interactive Q&A.

[**Start Learning →**](docs/REFERENCE.md)
**Start Learning →** [Reference Guide](docs/REFERENCE.md) | [Quick Overview](docs/overview/010_KEY_CONCEPTS.md)

<p align="right"><a href="#-table-of-contents-">⬆️ &nbsp;back to top</a></p>

Expand Down
34 changes: 34 additions & 0 deletions docs/REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ require "solid/process"

Solid::Process supports Ruby 2.7+ and Rails 6.0+. See the [README](../README.md) for the full compatibility matrix.

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## 2. Your First Process
Expand Down Expand Up @@ -165,6 +167,8 @@ result1 = Greeting.call(name: "Alice")
result2 = Greeting.call(name: "Bob")
```

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## 3. Input Definition & Validation
Expand Down Expand Up @@ -292,6 +296,8 @@ class User::Registration < Solid::Process
end
```

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## 4. Input Normalization
Expand Down Expand Up @@ -392,6 +398,8 @@ UserRegistration.input.normalize_value_for(:email, " [email protected]\n")
# => "[email protected]"
```

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## 5. Working with Results
Expand Down Expand Up @@ -490,6 +498,8 @@ end
| `Solid::Failure` | Failure results |
| `Solid::Output` | Alias for `Solid::Result` |

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## 6. Pattern Matching
Expand Down Expand Up @@ -602,6 +612,8 @@ in Solid::Failure[:creation_failed, {errors:}]
end
```

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## 7. Steps DSL
Expand Down Expand Up @@ -717,6 +729,8 @@ Given(a: 1, b: 2, c: 3)

This keeps your results clean, exposing only what callers need.

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## 8. Transactions
Expand Down Expand Up @@ -821,6 +835,8 @@ The `.then { |result| ... }` pattern lets you wrap only part of the chain in a t

**Note:** `rollback_on_failure` requires ActiveRecord and an active database connection.

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## 9. Dependencies
Expand Down Expand Up @@ -928,6 +944,8 @@ end

This allows you to swap `User::Creation` with a mock in tests.

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## 10. Process Composition
Expand Down Expand Up @@ -1037,6 +1055,8 @@ def create_user_token(user:, **)
end
```

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## 11. Callbacks
Expand Down Expand Up @@ -1186,6 +1206,8 @@ after_success { puts "3" } # Runs first
# Output: 3, 2, 1
```

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## 12. Error Handling
Expand Down Expand Up @@ -1302,6 +1324,8 @@ end
# => Solid::Process::Error: "`Failure!()` cannot be called because the `MyProcess#output` is already set."
```

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## 13. Instrumentation
Expand Down Expand Up @@ -1399,6 +1423,8 @@ cleaner.add_silencer { |line| line.include?("/gems/") }
- **Production** — Audit process executions and investigate errors
- **Performance** — See which steps execute and identify bottlenecks

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## 14. Validators Reference
Expand Down Expand Up @@ -1507,6 +1533,8 @@ validates :email, email: true, allow_nil: true # Skip if nil
validates :email, email: true, allow_blank: true # Skip if blank (nil or "")
```

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## 15. Internal Libraries
Expand Down Expand Up @@ -1610,6 +1638,8 @@ class User::Creation < Solid::Process
end
```

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## 16. Testing
Expand Down Expand Up @@ -1827,6 +1857,8 @@ RSpec.describe User::Creation do
end
```

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>

---

## What's Next?
Expand All @@ -1847,3 +1879,5 @@ For real-world examples, check:
- [Solid Rails App](https://github.com/solid-process/solid-rails-app) — Complete Rails application

For questions or issues, visit the [GitHub repository](https://github.com/solid-process/solid-process).

<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>