From 4a474a8d5cfd14dc0f25b588e7f6a002af205e43 Mon Sep 17 00:00:00 2001 From: Rodrigo Serradura Date: Thu, 29 Jan 2026 14:12:38 -0300 Subject: [PATCH 1/9] Fix redundant relative path in REFERENCE.md breadcrumbs --- docs/REFERENCE.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/REFERENCE.md b/docs/REFERENCE.md index bfc2344..20f5396 100644 --- a/docs/REFERENCE.md +++ b/docs/REFERENCE.md @@ -1,3 +1,11 @@ + + +`Previous` [README](../README.md#-table-of-contents-) | `Next` [Quick Overview](overview/010_KEY_CONCEPTS.md) + + + +--- + # 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. @@ -1881,3 +1889,11 @@ For real-world examples, check: For questions or issues, visit the [GitHub repository](https://github.com/solid-process/solid-process).

⬆️  back to top

+ +--- + + + +`Previous` [README](../README.md#-table-of-contents-) | `Next` [Quick Overview](overview/010_KEY_CONCEPTS.md) + + From 67baf817cb9eb1da422dad405d66caa0e6ca571b Mon Sep 17 00:00:00 2001 From: Rodrigo Serradura Date: Thu, 29 Jan 2026 14:14:40 -0300 Subject: [PATCH 2/9] Update documentation links and breadcrumb navigation Reorder Further Reading section in README and update Previous links in 010_KEY_CONCEPTS to point to the Documentation heading. --- README.md | 4 ++-- docs/overview/010_KEY_CONCEPTS.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a84c510..d774227 100644 --- a/README.md +++ b/README.md @@ -90,9 +90,9 @@ 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, or explore the [AI-Powered Wiki](https://deepwiki.com/solid-process/solid-process) for visual diagrams and interactive Q&A. +**Want a quick overview?** Explore the [Quick Overview](docs/overview/010_KEY_CONCEPTS.md) series for bite-sized guides on key topics. -**Start Learning →** [Reference Guide](docs/REFERENCE.md) | [Quick Overview](docs/overview/010_KEY_CONCEPTS.md) +> **🤖 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.

⬆️  back to top

diff --git a/docs/overview/010_KEY_CONCEPTS.md b/docs/overview/010_KEY_CONCEPTS.md index d39ab49..5b82473 100644 --- a/docs/overview/010_KEY_CONCEPTS.md +++ b/docs/overview/010_KEY_CONCEPTS.md @@ -1,6 +1,6 @@ -`Previous` [Table of Contents](../README.md#further-reading) | `Next` [Basic Usage](./020_BASIC_USAGE.md) +`Previous` [README](../README.md#-documentation) | `Next` [Basic Usage](./020_BASIC_USAGE.md) @@ -49,6 +49,6 @@ Using the emerging design concept, I invite you to embrace this development cycl -`Previous` [Table of Contents](../README.md#further-reading) | `Next` [Basic Usage](./020_BASIC_USAGE.md) +`Previous` [README](../README.md#-documentation) | `Next` [Basic Usage](./020_BASIC_USAGE.md) From 7d6e3fd0fed3c660f27390b62807cda79ecf8103 Mon Sep 17 00:00:00 2001 From: Rodrigo Serradura Date: Thu, 29 Jan 2026 14:16:30 -0300 Subject: [PATCH 3/9] Fix Previous link path in 010_KEY_CONCEPTS breadcrumbs Use ../../README.md instead of ../README.md to correctly resolve from docs/overview/ to the root README. --- docs/overview/010_KEY_CONCEPTS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/overview/010_KEY_CONCEPTS.md b/docs/overview/010_KEY_CONCEPTS.md index 5b82473..b253c81 100644 --- a/docs/overview/010_KEY_CONCEPTS.md +++ b/docs/overview/010_KEY_CONCEPTS.md @@ -1,6 +1,6 @@ -`Previous` [README](../README.md#-documentation) | `Next` [Basic Usage](./020_BASIC_USAGE.md) +`Previous` [README](../../README.md#-documentation) | `Next` [Basic Usage](./020_BASIC_USAGE.md) @@ -49,6 +49,6 @@ Using the emerging design concept, I invite you to embrace this development cycl -`Previous` [README](../README.md#-documentation) | `Next` [Basic Usage](./020_BASIC_USAGE.md) +`Previous` [README](../../README.md#-documentation) | `Next` [Basic Usage](./020_BASIC_USAGE.md) From 58a82dac274b51aa371d975c6d50681ecd249e79 Mon Sep 17 00:00:00 2001 From: Rodrigo Serradura Date: Thu, 29 Jan 2026 14:17:26 -0300 Subject: [PATCH 4/9] Move AI Agents callout to Further Reading section --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d774227..f8b842b 100644 --- a/README.md +++ b/README.md @@ -92,8 +92,6 @@ You can also check the [examples](examples) directory for more simple examples o **Want a quick overview?** Explore the [Quick Overview](docs/overview/010_KEY_CONCEPTS.md) series for bite-sized guides on key topics. -> **🤖 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. -

⬆️  back to top

## 📦 Installation @@ -170,6 +168,8 @@ See the [Reference Guide](docs/REFERENCE.md) for detailed explanations, validati | 9 | [Internal Libraries](docs/overview/090_INTERNAL_LIBRARIES.md) — Solid::Model, Value, Input | | 10 | [Ports and Adapters](docs/overview/100_PORTS_AND_ADAPTERS.md) — Hexagonal architecture | +> **🤖 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. +

⬆️  back to top

## 🛠️ Development From 48ffef3e44caf16084eecd1a240f3b9bea576f50 Mon Sep 17 00:00:00 2001 From: Rodrigo Serradura Date: Thu, 29 Jan 2026 14:18:42 -0300 Subject: [PATCH 5/9] Remove AI Agents callout from Further Reading section --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index f8b842b..b76f486 100644 --- a/README.md +++ b/README.md @@ -168,8 +168,6 @@ See the [Reference Guide](docs/REFERENCE.md) for detailed explanations, validati | 9 | [Internal Libraries](docs/overview/090_INTERNAL_LIBRARIES.md) — Solid::Model, Value, Input | | 10 | [Ports and Adapters](docs/overview/100_PORTS_AND_ADAPTERS.md) — Hexagonal architecture | -> **🤖 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. -

⬆️  back to top

## 🛠️ Development From 21b912eb2553c660cf3d8edf798a985f4ebf6653 Mon Sep 17 00:00:00 2001 From: Rodrigo Serradura Date: Thu, 29 Jan 2026 14:20:43 -0300 Subject: [PATCH 6/9] Reorder README sections: move Getting Started after Basic Structure Place Installation and Basic Structure before Getting Started so readers see what the gem looks like before being directed to guides. --- README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index b76f486..78e5ce5 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,9 @@ ## 📚 Table of Contents - [💡 Introduction](#-introduction) -- [🚀 Getting Started](#-getting-started) - [📦 Installation](#-installation) - [🏗️ The Basic Structure](#️-the-basic-structure) +- [🚀 Getting Started](#-getting-started) - [🗂️ Documentation](#️-documentation) - [🛠️ Development](#️-development) - [🤝 Contributing](#-contributing) @@ -81,19 +81,6 @@ You can also check the [examples](examples) directory for more simple examples o

⬆️  back to top

-## 🚀 Getting Started - -**New to Solid::Process?** The comprehensive [Reference Guide](docs/REFERENCE.md) covers everything you need to know: - -- ✅ Step-by-step tutorial from basics to advanced -- ✅ Real-world examples (User Registration system) -- ✅ All features explained with working code -- ✅ Perfect for developers AND AI coding agents - -**Want a quick overview?** Explore the [Quick Overview](docs/overview/010_KEY_CONCEPTS.md) series for bite-sized guides on key topics. - -

⬆️  back to top

- ## 📦 Installation Install the gem and add to the application's Gemfile by executing: @@ -146,6 +133,17 @@ See the [Reference Guide](docs/REFERENCE.md) for detailed explanations, validati

⬆️  back to top

+## 🚀 Getting Started + +**New to Solid::Process?** The comprehensive [Reference Guide](docs/REFERENCE.md) covers everything you need to know: + +- ✅ Step-by-step tutorial from basics to advanced +- ✅ Real-world examples (User Registration system) +- ✅ All features explained with working code +- ✅ Perfect for developers AND AI coding agents + +

⬆️  back to top

+ ## 🗂️ Documentation > [!TIP] From 9cab1a2fb3f07401e7e383ec226f2024ba55cfe3 Mon Sep 17 00:00:00 2001 From: Rodrigo Serradura Date: Thu, 29 Jan 2026 14:21:56 -0300 Subject: [PATCH 7/9] Remove duplicate Reference Guide link from Basic Structure section --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 78e5ce5..796800d 100644 --- a/README.md +++ b/README.md @@ -129,8 +129,6 @@ result[:user] # => # > **Note:** For validation including password confirmation, see the [Reference Guide](docs/REFERENCE.md). -See the [Reference Guide](docs/REFERENCE.md) for detailed explanations, validations, steps DSL, dependencies, and more. -

⬆️  back to top

## 🚀 Getting Started From 5eea4f9eab496bfa779495171edc624e375eaa22 Mon Sep 17 00:00:00 2001 From: Rodrigo Serradura Date: Thu, 29 Jan 2026 14:23:27 -0300 Subject: [PATCH 8/9] Update Previous link anchor to Table of Contents in 010_KEY_CONCEPTS --- docs/overview/010_KEY_CONCEPTS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/overview/010_KEY_CONCEPTS.md b/docs/overview/010_KEY_CONCEPTS.md index b253c81..5c572d4 100644 --- a/docs/overview/010_KEY_CONCEPTS.md +++ b/docs/overview/010_KEY_CONCEPTS.md @@ -1,6 +1,6 @@ -`Previous` [README](../../README.md#-documentation) | `Next` [Basic Usage](./020_BASIC_USAGE.md) +`Previous` [README](../../README.md#-table-of-contents-) | `Next` [Basic Usage](./020_BASIC_USAGE.md) @@ -49,6 +49,6 @@ Using the emerging design concept, I invite you to embrace this development cycl -`Previous` [README](../../README.md#-documentation) | `Next` [Basic Usage](./020_BASIC_USAGE.md) +`Previous` [README](../../README.md#-table-of-contents-) | `Next` [Basic Usage](./020_BASIC_USAGE.md) From bb23f7853db5ff52e4e8d8e2bf3bb0d79f6177e3 Mon Sep 17 00:00:00 2001 From: Rodrigo Serradura Date: Thu, 29 Jan 2026 14:28:11 -0300 Subject: [PATCH 9/9] Restructure documentation conventions with breadcrumb nav section Extract breadcrumb navigation into its own section, add REFERENCE.md nav docs, and fix overview Previous link path to match actual targets. --- .claude/docs/documentation.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/.claude/docs/documentation.md b/.claude/docs/documentation.md index 6b2ee98..d28bed8 100644 --- a/.claude/docs/documentation.md +++ b/.claude/docs/documentation.md @@ -7,7 +7,15 @@ Both `README.md` and `docs/REFERENCE.md` use back-to-top navigation after each m 1. Add `

⬆️  back to top

` before the `---` that closes the section 2. Update the Table of Contents with the new entry -## Overview File Structure +## Breadcrumb Navigation + +Both `docs/REFERENCE.md` and all `docs/overview/` files use header and footer nav blocks with `Previous`/`Next` links wrapped in `` tags. + +### REFERENCE.md + +Uses the same layout as overview files (header nav → `---` → content → `---` → footer nav). Its `Previous` links to `../README.md#-table-of-contents-` and `Next` links to `overview/010_KEY_CONCEPTS.md`. + +### Overview Files Each file in `docs/overview/` follows this layout: @@ -17,7 +25,7 @@ Each file in `docs/overview/` follows this layout: 4. **`---`** separator 5. **Footer nav** — `` block with the same `` `Previous` ``/`` `Next` `` links as the header -Navigation chain: `010_KEY_CONCEPTS` → `020_BASIC_USAGE` → … → `100_PORTS_AND_ADAPTERS`. The first file's `Previous` links to `../README.md#further-reading`; the last file's `Next` links to `../REFERENCE.md`. +Navigation chain: `010_KEY_CONCEPTS` → `020_BASIC_USAGE` → … → `100_PORTS_AND_ADAPTERS`. The first file's `Previous` links to `../../README.md#-table-of-contents-`; the last file's `Next` links to `../REFERENCE.md`. When adding a new overview file: