Skip to content

Commit 686917e

Browse files
committed
docs: restore runnable onboarding path
1 parent 3382319 commit 686917e

File tree

5 files changed

+29
-18
lines changed

5 files changed

+29
-18
lines changed

content/en/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ let one_per_day = factory
6868
<span class="terminal-title">bash - solverforge</span>
6969
</div>
7070
<div class="terminal-body">
71-
<pre><code><span class="command-line">cargo new employee-scheduling</span>
72-
<span class="command-line">cd employee-scheduling</span>
73-
<span class="command-line">cargo add solverforge</span></code></pre>
71+
<pre><code><span class="command-line">git clone https://github.com/SolverForge/solverforge-quickstarts</span>
72+
<span class="command-line">cd solverforge-quickstarts/rust/employee-scheduling</span>
73+
<span class="command-line">cargo run</span></code></pre>
7474
</div>
7575
</div>
7676

content/en/blog/technical/how-we-build-frontends.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ GET /demo-data/{id} → Generate sample problem
428428
POST /schedules → Submit problem, start solving
429429
GET /schedules/{id} → Get current solution
430430
GET /schedules/{id}/status → Lightweight status check
431-
PUT /schedules/{id}/analyze → Score breakdown
431+
PUT /schedules/analyze → Score breakdown
432432
DELETE /schedules/{id} → Stop solving
433433
```
434434

content/en/docs/getting-started/_index.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,19 @@ domain modeling, constraint streams, and a complete web application.
2727
## Getting the Code
2828

2929
```bash
30-
cargo new employee-scheduling
31-
cd employee-scheduling
32-
cargo add solverforge
30+
git clone https://github.com/SolverForge/solverforge-quickstarts
31+
cd solverforge-quickstarts/rust/employee-scheduling
32+
cargo build --release
33+
cargo run --release
3334
```
3435

35-
Then follow the [Employee Scheduling tutorial](employee-scheduling-rust/) to add
36-
the domain model, constraints, and runnable web UI.
36+
This is the current runnable onboarding path while the scaffolded app workflow
37+
is still evolving. Follow the
38+
[Employee Scheduling tutorial](employee-scheduling-rust/) to understand the
39+
domain model, constraints, and web UI implementation.
3740

3841
## Where to Read More
3942

43+
- [Quickstarts repository](https://github.com/solverforge/solverforge-quickstarts)
4044
- [SolverForge API documentation](https://docs.rs/solverforge)
41-
- [GitHub repository](https://github.com/solverforge/solverforge)
45+
- [Core GitHub repository](https://github.com/solverforge/solverforge)

content/en/docs/getting-started/employee-scheduling-rust.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,14 @@ SolverForge's Rust implementation offers key advantages:
8686

8787
### Running the Application
8888

89-
1. **Create a new Rust project:**
89+
This walkthrough follows the current employee scheduling example from the
90+
`solverforge-quickstarts` repository.
91+
92+
1. **Clone the quickstarts repository:**
9093

9194
```bash
92-
cargo new employee-scheduling
93-
cd employee-scheduling
94-
cargo add solverforge
95+
git clone https://github.com/SolverForge/solverforge-quickstarts
96+
cd ./solverforge-quickstarts/rust/employee-scheduling
9597
```
9698

9799
2. **Build the project:**
@@ -118,7 +120,7 @@ respecting business rules.
118120
### File Structure Overview
119121

120122
```
121-
employee-scheduling/
123+
solverforge-quickstarts/rust/employee-scheduling/
122124
├── src/
123125
│ ├── main.rs # Axum server entry point
124126
│ ├── lib.rs # Library crate root
@@ -1206,15 +1208,19 @@ curl -X PUT http://localhost:7860/schedules/analyze \
12061208
### Common Gotchas
12071209

12081210
1. **Forgot to call `finalize()`** on employees after construction
1211+
12091212
- Symptom: `flatten_last` constraints don't match anything
12101213

12111214
2. **Index out of sync** — employee indices don't match array positions
1215+
12121216
- Always use `enumerate()` when constructing employees
12131217

12141218
3. **Missing `factory.clone()`** — factory is consumed by each constraint
1219+
12151220
- Clone before each constraint chain
12161221

12171222
4. **Forgot to add constraint to return tuple**
1223+
12181224
- Constraint silently not evaluated
12191225

12201226
5. **Using `String` instead of `usize` for references**
@@ -1224,5 +1230,6 @@ curl -X PUT http://localhost:7860/schedules/analyze \
12241230

12251231
### Additional Resources
12261232

1227-
- [GitHub Repository](https://github.com/solverforge/solverforge)
1233+
- [Quickstarts Repository](https://github.com/solverforge/solverforge-quickstarts)
1234+
- [Core GitHub Repository](https://github.com/solverforge/solverforge)
12281235
- [SolverForge Rust API Documentation](/docs/api/rust/)

content/en/docs/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,8 @@ in Rust. The API is complete and stable at v0.6.0. {{% /pageinfo %}}
157157

158158
**Want to try it today?**
159159

160-
- Install via `cargo add solverforge` and follow
161-
[Getting Started](/docs/getting-started/)
160+
- Follow [Getting Started](/docs/getting-started/) to run the current employee
161+
scheduling quickstart locally
162162

163163
## What's Complete
164164

0 commit comments

Comments
 (0)