Feat/add tutorial project

[sheepla]

---

Summary by CodeRabbit

• Documentation

  • Updated Quick Start with a runnable hello-example, verification steps, and Scalar API reference UI instructions.
  • Updated homepage examples to show the new hello endpoint and refreshed guidance.

• New Features

  • Added a tutorial project demonstrating running AxisEndpoints with Scalar API docs, a GET /hello example, and an included test request.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 531255f0-4204-42a4-9c02-465943869201

📥 Commits

Reviewing files that changed from the base of the PR and between b50eb16 and 443b13d.

📒 Files selected for processing (4)

• docs/src/content/docs/getting-started/quick-start.mdx
• tests/AxisEndpoints.Tutorial/AxisEndpoints.Tutorial.http
• tests/AxisEndpoints.Tutorial/Features/Hello/HelloEndpoint.cs
• tests/AxisEndpoints.Tutorial/README.md

✅ Files skipped from review due to trivial changes (2)

• tests/AxisEndpoints.Tutorial/README.md
• docs/src/content/docs/getting-started/quick-start.mdx

🚧 Files skipped from review as they are similar to previous changes (1)

• tests/AxisEndpoints.Tutorial/AxisEndpoints.Tutorial.http

---

📝 Walkthrough

Walkthrough

Creates a new tutorial project AxisEndpoints.Tutorial, adds a HelloEndpoint example and supporting records, integrates Scalar.AspNetCore and OpenAPI mapping (/scalar), updates example/test files and launch/config, and replaces the CreateUser examples in the docs with the HelloEndpoint tutorial.

Changes

AxisEndpoints Tutorial + Docs

Layer / File(s)	Summary
Project Structure & Dependencies tests/AxisEndpoints.Tutorial/AxisEndpoints.Tutorial.csproj	Adds new Web SDK project targeting net10.0 with package refs: AxisEndpoints v0.0.3, Microsoft.AspNetCore.OpenApi v10.0.2, Scalar.AspNetCore v2.14.9.
Launch & Configuration tests/AxisEndpoints.Tutorial/Properties/launchSettings.json, tests/AxisEndpoints.Tutorial/appsettings.json, tests/AxisEndpoints.Tutorial/appsettings.Development.json	Adds launch profiles (http/https) with applicationUrl including http://localhost:5173, sets ASPNETCORE_ENVIRONMENT=Development, and configures logging levels.
Endpoint Data Shape tests/AxisEndpoints.Tutorial/Features/Hello/HelloEndpoint.cs	Introduces HelloRequest (required string Name) and HelloResponse (required string Message) records.
Core Endpoint Implementation tests/AxisEndpoints.Tutorial/Features/Hello/HelloEndpoint.cs	Adds HelloEndpoint : IEndpoint<HelloRequest, IResult> registering GET /hello, validates Name (returns 400 Problem when missing), logs, and returns JSON HelloResponse greeting.
App Wiring / Runtime tests/AxisEndpoints.Tutorial/Program.cs, tests/AxisEndpoints.Example/Program.cs	Registers AddOpenApi() and AddAxisEndpoints(), maps MapOpenApi(), MapAxisEndpoints(), and MapScalarApiReference() (Scalar UI at /scalar), and uses app.Run(); updates example comment to reference /scalar.
Tests / HTTP Smoke tests/AxisEndpoints.Tutorial/AxisEndpoints.Tutorial.http	Adds HTTP request file with @AxisEndpoints.Tutorial_HostAddress and a GET /hello?name=Alice request.
Documentation & README docs/src/content/docs/getting-started/quick-start.mdx, docs/src/content/docs/index.mdx, tests/AxisEndpoints.Tutorial/README.md	Quick Start and homepage examples replaced with HelloEndpoint sample and updated verification steps (Scalar UI at /scalar); tutorial README added with setup/run instructions and sample code.
Editor Cache tests/AxisEndpoints.Tests/AxisEndpoints.Tests.csproj.lscache	Language-service cache paths updated to use <NUGET>/ placeholders instead of relative dotnet-cli package paths.

Sequence Diagram(s)

(Skipped — changes are primarily new tutorial wiring and documentation; no multi-component control flow requiring sequence visualization.)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• docs: simplify README and create Astro Starlight documentation pages #13: Modifies the same docs pages (quick-start and index) with overlapping tutorial/example updates.
• Devin/1777647229 docs improvements #15: Also updates quick-start/index examples and Scalar integration instructions, closely related to these doc changes.

Poem

🐰 A tiny hop, a friendly "Hello!" rings,
Docs refreshed and local server springs,
Scalar shines at /scalar for all to see,
A tutorial blooms — come run it with me!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Feat/add tutorial project' directly reflects the main change: introducing a new tutorial project with example code, documentation, and configuration files.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/add-tutorial-project

---

_{Review rate limit: 9/10 reviews remaining, refill in 6 minutes.}

_{Comment @coderabbitai help to get the list of available commands and usage tips.}