Skip to content
Merged
12 changes: 10 additions & 2 deletions .claude/docs/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,15 @@ Both `README.md` and `docs/REFERENCE.md` use back-to-top navigation after each m
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

## 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 `<small>` 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:

Expand All @@ -17,7 +25,7 @@ Each file in `docs/overview/` follows this layout:
4. **`---`** separator
5. **Footer nav** — `<small>` 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:

Expand Down
28 changes: 11 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
## 📚 Table of Contents <!-- omit from toc -->

- [💡 Introduction](#-introduction)
- [🚀 Getting Started](#-getting-started)
- [📦 Installation](#-installation)
- [🏗️ The Basic Structure](#️-the-basic-structure)
- [🚀 Getting Started](#-getting-started)
- [🗂️ Documentation](#️-documentation)
- [🛠️ Development](#️-development)
- [🤝 Contributing](#-contributing)
Expand Down Expand Up @@ -81,21 +81,6 @@ You can also check the [examples](examples) directory for more simple examples o

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

## 🚀 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

> **🤖 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 →** [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>

## 📦 Installation

Install the gem and add to the application's Gemfile by executing:
Expand Down Expand Up @@ -144,7 +129,16 @@ result[:user] # => #<User id: 1, ...>

> **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.
<p align="right"><a href="#-table-of-contents-">⬆️ &nbsp;back to top</a></p>

## 🚀 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

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

Expand Down
16 changes: 16 additions & 0 deletions docs/REFERENCE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
<small>

`Previous` [README](../README.md#-table-of-contents-) | `Next` [Quick Overview](overview/010_KEY_CONCEPTS.md)

</small>

---

# 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 Expand Up @@ -1881,3 +1889,11 @@ For real-world examples, check:
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>

---

<small>

`Previous` [README](../README.md#-table-of-contents-) | `Next` [Quick Overview](overview/010_KEY_CONCEPTS.md)

</small>
4 changes: 2 additions & 2 deletions docs/overview/010_KEY_CONCEPTS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<small>

`Previous` [Table of Contents](../README.md#further-reading) | `Next` [Basic Usage](./020_BASIC_USAGE.md)
`Previous` [README](../../README.md#-table-of-contents-) | `Next` [Basic Usage](./020_BASIC_USAGE.md)

</small>

Expand Down Expand Up @@ -49,6 +49,6 @@ Using the emerging design concept, I invite you to embrace this development cycl

<small>

`Previous` [Table of Contents](../README.md#further-reading) | `Next` [Basic Usage](./020_BASIC_USAGE.md)
`Previous` [README](../../README.md#-table-of-contents-) | `Next` [Basic Usage](./020_BASIC_USAGE.md)

</small>