Skip to content

Commit d9429a6

Browse files
author
vp
committed
feat(docs): refine documentation content and structure for clarity and consistency
1 parent 6fcbb7e commit d9429a6

7 files changed

Lines changed: 9 additions & 29 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ the [CHANGELOG](https://raw.githubusercontent.com/bridgingIT/bITdevKit/main/CHAN
5252

5353
## Documentation
5454

55-
The public documentation site is available at
55+
The documentation site is available at
5656
[bridgingit-gmbh.github.io/bITdevKit](https://bridgingit-gmbh.github.io/bITdevKit/).
5757

5858
The best entry point into the current documentation set is the

docs/site/architecture.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,3 @@ sequenceDiagram
9393
- [Requester and Notifier](reference/features-requester-notifier.md)
9494
- [Modules](reference/features-modules.md)
9595
- [Presentation Endpoints](reference/features-presentation-endpoints.md)
96-
97-
## Related decisions
98-
99-
- [Messaging vs Queueing](decisions-messaging-vs-queueing.md)
100-
- [Repository vs ActiveEntity](decisions-repository-vs-activeentity.md)

docs/site/examples.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,4 @@ Path:
5050
Best for:
5151

5252
- a lighter-weight example
53-
- fast experimentation with less surface area
54-
55-
## Suggested progression
56-
57-
1. Start with [Getting Started](getting-started.md)
58-
2. Run the `GettingStarted` example
59-
3. Read the [DDD Introduction](reference/introduction-ddd-guide.md)
60-
4. Move to `DoFiesta` or `EventSourcingDemo` depending on the scenario of interest
53+
- fast experimentation with less surface area

docs/site/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ hide:
5454
</a>
5555
<a class="gateway-card" href="reference/">
5656
<h3>Read the docs</h3>
57-
<p>Browse the full public documentation map by capability area and feature-specific guide.</p>
57+
<p>Browse the documentation map by capability area and feature-specific guide.</p>
5858
</a>
5959
</div>
6060

docs/site/why.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,4 @@ structure to be more intentional and more repeatable.
6161
| Modular boundaries | Manual conventions | First-class module composition patterns |
6262
| Queueing and messaging | Usually added separately | Integrated concepts with related operational support |
6363
| Operational endpoints | Typically custom | Reusable patterns for inspection and control |
64-
| Onboarding | Team-specific | Templates, examples, and aligned docs |
65-
66-
## Good next pages
67-
68-
- [Architecture](architecture.md)
69-
- [Packages](packages.md)
70-
- [Examples](examples.md)
71-
- [Messaging vs Queueing](decisions-messaging-vs-queueing.md)
72-
- [Repository vs ActiveEntity](decisions-repository-vs-activeentity.md)
64+
| Onboarding | Team-specific | Templates, examples, and aligned docs |

docs/specs/spec-gh-pages-landing-page.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ The public site content shall be curated rather than directly exposing all repos
151151
That means:
152152

153153
- landing-page content is authored specifically for the site
154-
- public documentation pages are selected, adapted, or synchronized from suitable repository docs
154+
- Documentation pages are selected, adapted, or synchronized from suitable repository docs
155155
- internal or low-signal documentation remains outside the public site
156156

157157
The public site is therefore a curated documentation product, not just a renderer over arbitrary repository files.

mkdocs.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ nav:
1717
- Architecture: architecture.md
1818
- Packages: packages.md
1919
- Examples: examples.md
20-
- Decisions:
21-
- Overview: decisions.md
22-
- Messaging vs Queueing: decisions-messaging-vs-queueing.md
23-
- Repository vs ActiveEntity: decisions-repository-vs-activeentity.md
20+
# - Decisions:
21+
# - Overview: decisions.md
22+
# - Messaging vs Queueing: decisions-messaging-vs-queueing.md
23+
# - Repository vs ActiveEntity: decisions-repository-vs-activeentity.md
2424
- Documentation:
2525
- Overview: reference/index.md
2626
- Common Infrastructure:

0 commit comments

Comments
 (0)