Skip to content

Docs enhancements #15

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 4 commits into from
Jan 29, 2026
Merged

Docs enhancements #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
51d3c84
Rename REFERENCE.md title to align with README
serradura Jan 29, 2026
917a210
Ignore docs/plans/ directory
serradura Jan 29, 2026
820bdcf
Add gem version badge and replace tip with DeepWiki link
serradura Jan 29, 2026
3c32db2
Add DeepWiki link to Getting Started AI Agents callout
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ gemfiles/.bundle/
.tool-versions

/.claude/settings.local.json
/docs/plans/
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
<a href="https://deepwiki.com/solid-process/solid-process"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
<a href="https://qlty.sh/gh/solid-process/projects/solid-process"><img src="https://qlty.sh/gh/solid-process/projects/solid-process/maintainability.svg" alt="Maintainability" /></a>
<a href="https://qlty.sh/gh/solid-process/projects/solid-process"><img src="https://qlty.sh/gh/solid-process/projects/solid-process/coverage.svg" alt="Code Coverage" /></a>
<br/>
<a href="https://badge.fury.io/rb/solid-process"><img src="https://badge.fury.io/rb/solid-process.svg" alt="Gem Version" height="18"></a>
<img src="https://img.shields.io/badge/Ruby%20%3E%3D%202.7%2C%20%3C%3D%20Head-ruby.svg?colorA=444&colorB=333" alt="Ruby">
<img src="https://img.shields.io/badge/Rails%20%3E%3D%206.0%2C%20%3C%3D%20Edge-rails.svg?colorA=444&colorB=333" alt="Rails">
</p>
Expand Down Expand Up @@ -87,7 +89,7 @@ You can also check the [examples](examples) directory for more simple examples o
- ✅ All features explained with working code
- ✅ Perfect for developers AND AI coding agents

> **🤖 AI Agents:** Point your coding assistant to [`docs/REFERENCE.md`](docs/REFERENCE.md) for complete API knowledge and patterns.
> **🤖 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)

Expand Down Expand Up @@ -150,7 +152,7 @@ See the [Reference Guide](docs/REFERENCE.md) for detailed explanations, validati
> [!TIP]
> **[Full Reference →](docs/REFERENCE.md)** — Complete guide covering every feature with detailed examples.
>
> _**Perfect for developers and AI coding agents**._
> **[AI-Powered Wiki →](https://deepwiki.com/solid-process/solid-process)** — Visual diagrams, architecture flows, and interactive Q&A beyond the official docs.

**Quick Overview** — Bite-sized guides for each topic:

Expand Down
2 changes: 1 addition & 1 deletion docs/REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Getting Started with Solid::Process
# Solid::Process — Reference Guide

This guide teaches everything you need to know about Solid::Process, from basic concepts to advanced patterns. Work through it progressively, or jump to the section you need.

Expand Down