Skip to content

Commit 21b912e

Browse files
committed
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.
1 parent 48ffef3 commit 21b912e

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
## πŸ“š Table of Contents <!-- omit from toc -->
1717

1818
- [πŸ’‘ Introduction](#-introduction)
19-
- [πŸš€ Getting Started](#-getting-started)
2019
- [πŸ“¦ Installation](#-installation)
2120
- [πŸ—οΈ The Basic Structure](#️-the-basic-structure)
21+
- [πŸš€ Getting Started](#-getting-started)
2222
- [πŸ—‚οΈ Documentation](#️-documentation)
2323
- [πŸ› οΈ Development](#️-development)
2424
- [🀝 Contributing](#-contributing)
@@ -81,19 +81,6 @@ You can also check the [examples](examples) directory for more simple examples o
8181

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

84-
## πŸš€ Getting Started
85-
86-
**New to Solid::Process?** The comprehensive [Reference Guide](docs/REFERENCE.md) covers everything you need to know:
87-
88-
- βœ… Step-by-step tutorial from basics to advanced
89-
- βœ… Real-world examples (User Registration system)
90-
- βœ… All features explained with working code
91-
- βœ… Perfect for developers AND AI coding agents
92-
93-
**Want a quick overview?** Explore the [Quick Overview](docs/overview/010_KEY_CONCEPTS.md) series for bite-sized guides on key topics.
94-
95-
<p align="right"><a href="#-table-of-contents-">⬆️ &nbsp;back to top</a></p>
96-
9784
## πŸ“¦ Installation
9885

9986
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
146133

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

136+
## πŸš€ Getting Started
137+
138+
**New to Solid::Process?** The comprehensive [Reference Guide](docs/REFERENCE.md) covers everything you need to know:
139+
140+
- βœ… Step-by-step tutorial from basics to advanced
141+
- βœ… Real-world examples (User Registration system)
142+
- βœ… All features explained with working code
143+
- βœ… Perfect for developers AND AI coding agents
144+
145+
<p align="right"><a href="#-table-of-contents-">⬆️ &nbsp;back to top</a></p>
146+
149147
## πŸ—‚οΈ Documentation
150148

151149
> [!TIP]

0 commit comments

Comments
Β (0)