Add Getting Started guides to setup pages and new Testing section#7
Draft
Add Getting Started guides to setup pages and new Testing section#7
Conversation
Co-authored-by: bastianeicher <414366+bastianeicher@users.noreply.github.com>
Co-authored-by: bastianeicher <414366+bastianeicher@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Enhance documentation with getting started guides and testing section
Add Getting Started guides to setup pages and new Testing section
Feb 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Setup pages previously only listed package dependencies. This adds comprehensive Getting Started guides showing how to actually use TypedRest, plus a new Testing section explaining how to write unit tests for custom endpoint classes.
Changes
Extended Setup Pages
Added step-by-step Getting Started guides to all setup pages:
EntryEndpointwith resource propertiesJava/Kotlin page uses tabbed syntax for both languages (Maven/Gradle, Java/Kotlin examples).
Before:
## Dependencies Add one or more of the following NuGet packages...After:
New Testing Section
Created
docs/testing/index.mdwith:ElementEndpoint.read()Navigation
docs/.pagesto include testing section after setupdocs/index.mdto add Testing link in documentation listScreenshots
Homepage with new Testing section:

Testing page with tabbed examples:

Setup page with Getting Started guide:

Original prompt
Overview
The documentation needs two enhancements:
Part 1: Extend Setup Pages
The existing setup pages (
docs/setup/dotnet.md,docs/setup/java.md,docs/setup/typescript.md) are currently very bare-bones, only listing package dependencies. Each should be extended with a concise "Getting started" guide that shows the essential steps to begin using TypedRest. Keep the content focused and essential. Prefer linking to existing documentation (like the Introduction, Endpoints, Entry Endpoint, etc.) over duplicating content.For each platform, add a "Getting started" section that covers:
EntryEndpointpointing at an APIEntryEndpointand exposing a collection endpoint via a property/method (as shown in the Introduction)Platform-specific notes:
C#/.NET (
docs/setup/dotnet.md):TypedRestfrom NuGetEntryEndpointtakes aUriJava (
docs/setup/java.md):typedrestfrom Maven CentralEntryEndpointtakes aURIImplsuffix is used for implementation classes (e.g.,CollectionEndpointImpl)=== "Java"/=== "Kotlin"tab syntax that the docs already use (seedocs/introduction.mdfor examples)TypeScript (
docs/setup/typescript.md):typedrestfrom NPMEntryEndpointtakes aURLPart 2: Add Testing Section
Create a new
docs/testing/directory with anindex.mdfile that explains how to write unit tests for custom endpoint classes built with TypedRest.Testing patterns from the actual implementations:
C#/.NET (from
TypedRest/TypedRest-DotNet):[Fact]attributesEndpointTestBaseabstract class that provides aMockHttpMessageHandler(from theRichardSzalay.MockHttppackage) and anEntryEndpointwired to itMockHttpMessageHandleris used to set up expected HTTP requests and responses:Mock.Expect(HttpMethod.Get, "http://localhost/endpoint").Respond(JsonMime, """{"id":5,"name":"test"}""");EndpointTestBasedisposes the mock and verifies no outstanding expectationssrc/UnitTests/Endpoints/EndpointTestBase.cs:Java/Kotlin (from
TypedRest/TypedRest-Java):@TestannotationAbstractEndpointTestabstract class that provides aMockWebServer(from OkHttp) and anEntryEndpointwired to itMockWebServerqueues mock responses:server.enqueue(MockResponse().setJsonBody("""{"id":5,"name":"test"}"""))server.assertRequest(HttpMethod.GET)and.withJsonBody(...),.withHeader(...)typedrest/src/test/kotlin/net/typedrest/endpoints/AbstractEndpointTest.kt:typedrest/src/test/kotlin/net/typedrest/tests/MockWebServerExtensions.ktprovidingsetJsonBody,assertRequest,withJsonBody,withHeaderTypeScript (from `TypedRest/TypedRest-Typ...
This pull request was created from Copilot chat.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.