From 20203c3a8aec875d391f746d6c1eca75f69e2bf7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Valentin=20Breu=C3=9F?= Date: Wed, 8 Jul 2026 20:40:04 +0200 Subject: [PATCH 1/2] docs: rename principles page to 'Design principles' with short sidebar label --- Docs/pages/00-index.md | 2 +- Docs/pages/02-principles.md | 5 +++-- README.md | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/Docs/pages/00-index.md b/Docs/pages/00-index.md index c2051e1..48379f2 100644 --- a/Docs/pages/00-index.md +++ b/Docs/pages/00-index.md @@ -52,7 +52,7 @@ var cup = shop.Resolve(); // a fresh cup, wired and ready ## Where to go next - [Getting started](./getting-started) builds your first container end to end. -- [Principles & the composition root](./principles) is the design behind the mechanics; read it before the feature pages. +- [Design principles & the composition root](./principles) is the design behind the mechanics; read it before the feature pages. - [Lifetimes](./registration/lifetimes) explains singleton, scoped, and transient. - [Async initialization](./async-initialization) covers the headline feature. - [Diagnostics](./diagnostics) lists every compile-time check. diff --git a/Docs/pages/02-principles.md b/Docs/pages/02-principles.md index d50ed6f..65baeaf 100644 --- a/Docs/pages/02-principles.md +++ b/Docs/pages/02-principles.md @@ -1,9 +1,10 @@ --- -title: Principles & the composition root +title: Design principles & the composition root +sidebar_label: Design principles sidebar_position: 2 --- -# Principles & the composition root +# Design principles & the composition root The rest of these docs teach the *mechanics*: how to register services, resolve them, and keep their lifetimes honest. This page is about the *design* those mechanics serve. Awaiten enforces the mechanics for you (lifetimes, cycles, async ordering) and turns the ones it can see into build errors. It cannot enforce the design. That part is on you, and it is what this page is for. diff --git a/README.md b/README.md index 8217fba..41e731c 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ dotnet add package Awaiten Full documentation lives at [docs.testably.org/Awaiten](https://docs.testably.org/Awaiten). - [Getting started](https://docs.testably.org/Awaiten/getting-started) -- [Principles & the composition root](https://docs.testably.org/Awaiten/principles) +- [Design principles & the composition root](https://docs.testably.org/Awaiten/principles) - Registration: [lifetimes](https://docs.testably.org/Awaiten/registration/lifetimes), [factories and instances](https://docs.testably.org/Awaiten/registration/factories-and-instances), [decorators](https://docs.testably.org/Awaiten/registration/decorators), [composites](https://docs.testably.org/Awaiten/registration/composites), [keyed services](https://docs.testably.org/Awaiten/registration/keyed-services), [open generics](https://docs.testably.org/Awaiten/registration/open-generics), [scanning](https://docs.testably.org/Awaiten/registration/scanning), [modules](https://docs.testably.org/Awaiten/registration/modules) - Resolution: [resolving services](https://docs.testably.org/Awaiten/resolution/resolving-services), [relationships](https://docs.testably.org/Awaiten/resolution/relationships), [collections](https://docs.testably.org/Awaiten/resolution/collections), [keyed dictionaries](https://docs.testably.org/Awaiten/resolution/keyed-dictionaries), [property injection](https://docs.testably.org/Awaiten/resolution/property-injection), [runtime arguments](https://docs.testably.org/Awaiten/resolution/runtime-arguments), [context-aware factories](https://docs.testably.org/Awaiten/resolution/context-aware-factories) - [Async initialization](https://docs.testably.org/Awaiten/async-initialization) From f56de04e8337012c9c24dd7641d4e57ef4775408 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Valentin=20Breu=C3=9F?= Date: Wed, 8 Jul 2026 20:44:39 +0200 Subject: [PATCH 2/2] docs: rename principles page and slug to design-principles --- Docs/pages/00-index.md | 2 +- Docs/pages/{02-principles.md => 02-design-principles.md} | 0 README.md | 2 +- 3 files changed, 2 insertions(+), 2 deletions(-) rename Docs/pages/{02-principles.md => 02-design-principles.md} (100%) diff --git a/Docs/pages/00-index.md b/Docs/pages/00-index.md index 48379f2..334e00d 100644 --- a/Docs/pages/00-index.md +++ b/Docs/pages/00-index.md @@ -52,7 +52,7 @@ var cup = shop.Resolve(); // a fresh cup, wired and ready ## Where to go next - [Getting started](./getting-started) builds your first container end to end. -- [Design principles & the composition root](./principles) is the design behind the mechanics; read it before the feature pages. +- [Design principles & the composition root](./design-principles) is the design behind the mechanics; read it before the feature pages. - [Lifetimes](./registration/lifetimes) explains singleton, scoped, and transient. - [Async initialization](./async-initialization) covers the headline feature. - [Diagnostics](./diagnostics) lists every compile-time check. diff --git a/Docs/pages/02-principles.md b/Docs/pages/02-design-principles.md similarity index 100% rename from Docs/pages/02-principles.md rename to Docs/pages/02-design-principles.md diff --git a/README.md b/README.md index 41e731c..b73b536 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ dotnet add package Awaiten Full documentation lives at [docs.testably.org/Awaiten](https://docs.testably.org/Awaiten). - [Getting started](https://docs.testably.org/Awaiten/getting-started) -- [Design principles & the composition root](https://docs.testably.org/Awaiten/principles) +- [Design principles & the composition root](https://docs.testably.org/Awaiten/design-principles) - Registration: [lifetimes](https://docs.testably.org/Awaiten/registration/lifetimes), [factories and instances](https://docs.testably.org/Awaiten/registration/factories-and-instances), [decorators](https://docs.testably.org/Awaiten/registration/decorators), [composites](https://docs.testably.org/Awaiten/registration/composites), [keyed services](https://docs.testably.org/Awaiten/registration/keyed-services), [open generics](https://docs.testably.org/Awaiten/registration/open-generics), [scanning](https://docs.testably.org/Awaiten/registration/scanning), [modules](https://docs.testably.org/Awaiten/registration/modules) - Resolution: [resolving services](https://docs.testably.org/Awaiten/resolution/resolving-services), [relationships](https://docs.testably.org/Awaiten/resolution/relationships), [collections](https://docs.testably.org/Awaiten/resolution/collections), [keyed dictionaries](https://docs.testably.org/Awaiten/resolution/keyed-dictionaries), [property injection](https://docs.testably.org/Awaiten/resolution/property-injection), [runtime arguments](https://docs.testably.org/Awaiten/resolution/runtime-arguments), [context-aware factories](https://docs.testably.org/Awaiten/resolution/context-aware-factories) - [Async initialization](https://docs.testably.org/Awaiten/async-initialization)