Skip to content

Commit 90e9ed2

Browse files
authored
Merge pull request #15 from solid-process/chore/docs-enhancements
Docs enhancements
2 parents 7d7445c + 3c32db2 commit 90e9ed2

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@ gemfiles/.bundle/
1818
.tool-versions
1919

2020
/.claude/settings.local.json
21+
/docs/plans/

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
<a href="https://deepwiki.com/solid-process/solid-process"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
66
<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>
77
<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>
8+
<br/>
9+
<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>
810
<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">
911
<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">
1012
</p>
@@ -87,7 +89,7 @@ You can also check the [examples](examples) directory for more simple examples o
8789
- ✅ All features explained with working code
8890
- ✅ Perfect for developers AND AI coding agents
8991

90-
> **🤖 AI Agents:** Point your coding assistant to [`docs/REFERENCE.md`](docs/REFERENCE.md) for complete API knowledge and patterns.
92+
> **🤖 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.
9193
9294
[**Start Learning →**](docs/REFERENCE.md)
9395

@@ -150,7 +152,7 @@ See the [Reference Guide](docs/REFERENCE.md) for detailed explanations, validati
150152
> [!TIP]
151153
> **[Full Reference →](docs/REFERENCE.md)** — Complete guide covering every feature with detailed examples.
152154
>
153-
> _**Perfect for developers and AI coding agents**._
155+
> **[AI-Powered Wiki →](https://deepwiki.com/solid-process/solid-process)** — Visual diagrams, architecture flows, and interactive Q&A beyond the official docs.
154156
155157
**Quick Overview** — Bite-sized guides for each topic:
156158

docs/REFERENCE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Getting Started with Solid::Process
1+
# Solid::Process — Reference Guide
22

33
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.
44

0 commit comments

Comments
 (0)