Skip to content

Commit ef7522d

Browse files
author
hiwepy
committed
docs: expand sites with verified project content
1 parent ce33f73 commit ef7522d

16 files changed

Lines changed: 4185 additions & 175 deletions

‎.vitepress/config.mts‎

Lines changed: 65 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,91 @@
1-
import { defineConfig } from 'vitepress'
1+
import { withMermaid } from 'vitepress-plugin-mermaid'
22

3-
export default defineConfig({
3+
export default withMermaid({
44
title: 'DDD-4-Java',
5-
description: '面向 Java 生态的领域驱动设计（DDD）/ CQRS / 事件溯源（Event Sourcing）工程化基础构件',
5+
description: '框架无关的 DDD / CQRS / 事件驱动基础构件，以及面向 Spring Boot、Javalin、Quarkus 的运行时适配。',
66
lang: 'zh-CN',
77
lastUpdated: true,
88
cleanUrls: true,
99
appearance: 'dark',
1010
locales: {
11-
'root': {
11+
root: {
1212
label: '简体中文',
1313
lang: 'zh-CN',
1414
title: 'DDD-4-Java',
15-
description: '面向 Java 生态的领域驱动设计（DDD）/ CQRS / 事件溯源（Event Sourcing）工程化基础构件',
15+
description: '框架无关的 DDD / CQRS / 事件驱动基础构件，以及面向 Spring Boot、Javalin、Quarkus 的运行时适配。',
1616
},
17-
'en': {
17+
en: {
1818
label: 'English',
1919
lang: 'en-US',
2020
title: 'DDD-4-Java',
21-
description: 'Base classes for Domain-Driven Design (DDD) / CQRS / Event Sourcing in the Java ecosystem',
21+
description: 'Framework-neutral DDD, CQRS, and event-driven building blocks with runtime adapters for Spring Boot, Javalin, and Quarkus.',
2222
},
2323
},
24+
mermaid: {
25+
theme: 'neutral',
26+
},
2427
themeConfig: {
25-
nav: [
26-
{ text: '首页 / Home', link: '/', items: [
27-
{ text: '快速开始 / Getting Started', link: '/guide/getting-started' },
28-
{ text: '贡献指南 / Contributing', link: '/guide/contributing' },
29-
{ text: '许可证 / License', link: '/guide/license' },
30-
] },
31-
{ text: '仓库 / Repositories', link: '/repositories' },
32-
{ text: 'GitHub', link: 'https://github.com/ddd-4-java' },
33-
],
34-
sidebar: {
35-
'/guide/': [
36-
{
37-
text: '入门 / Getting Started',
38-
items: [
28+
socialLinks: [{ icon: 'github', link: 'https://github.com/ddd-4-java' }],
29+
search: { provider: 'local' },
30+
locales: {
31+
root: {
32+
label: '简体中文',
33+
nav: [
34+
{ text: '首页', link: '/' },
35+
{ text: '项目目录', link: '/repositories' },
36+
{ text: '指南', items: [
3937
{ text: '快速开始', link: '/guide/getting-started' },
38+
{ text: '生态架构', link: '/guide/ecosystem' },
4039
{ text: '贡献指南', link: '/guide/contributing' },
4140
{ text: '许可证', link: '/guide/license' },
42-
],
41+
] },
42+
{ text: 'GitHub', link: 'https://github.com/ddd-4-java' },
43+
],
44+
sidebar: {
45+
'/guide/': [{ text: '指南', items: [
46+
{ text: '快速开始', link: '/guide/getting-started' },
47+
{ text: '生态架构', link: '/guide/ecosystem' },
48+
{ text: '贡献指南', link: '/guide/contributing' },
49+
{ text: '许可证', link: '/guide/license' },
50+
] }],
51+
},
52+
outlineTitle: '本页目录',
53+
lastUpdatedText: '最后更新',
54+
docFooter: { prev: '上一页', next: '下一页' },
55+
footer: {
56+
message: '内容来自当前仓库与本地源码核验',
57+
copyright: 'Copyright © 2026 DDD-4-Java',
4358
},
44-
],
45-
'/en/guide/': [
46-
{
47-
text: 'Getting Started',
48-
items: [
49-
{ text: 'Quick Start', link: '/en/guide/getting-started' },
59+
},
60+
en: {
61+
label: 'English',
62+
nav: [
63+
{ text: 'Home', link: '/en/' },
64+
{ text: 'Repositories', link: '/en/repositories' },
65+
{ text: 'Guide', items: [
66+
{ text: 'Getting started', link: '/en/guide/getting-started' },
67+
{ text: 'Ecosystem', link: '/en/guide/ecosystem' },
5068
{ text: 'Contributing', link: '/en/guide/contributing' },
5169
{ text: 'License', link: '/en/guide/license' },
52-
],
70+
] },
71+
{ text: 'GitHub', link: 'https://github.com/ddd-4-java' },
72+
],
73+
sidebar: {
74+
'/en/guide/': [{ text: 'Guide', items: [
75+
{ text: 'Getting started', link: '/en/guide/getting-started' },
76+
{ text: 'Ecosystem', link: '/en/guide/ecosystem' },
77+
{ text: 'Contributing', link: '/en/guide/contributing' },
78+
{ text: 'License', link: '/en/guide/license' },
79+
] }],
5380
},
54-
],
55-
},
56-
socialLinks: [
57-
{ icon: 'github', link: 'https://github.com/ddd-4-java' },
58-
],
59-
footer: {
60-
message: '由 DDD-4-Java 用 ❤️ 制作 / Made with ❤️ by DDD-4-Java',
61-
copyright: `Apache 2.0 Licensed | Copyright © ${new Date().getFullYear()} DDD-4-Java`,
62-
},
63-
search: {
64-
provider: 'local',
81+
outlineTitle: 'On this page',
82+
lastUpdatedText: 'Last updated',
83+
docFooter: { prev: 'Previous', next: 'Next' },
84+
footer: {
85+
message: 'Content verified against current repositories and local source',
86+
copyright: 'Copyright © 2026 DDD-4-Java',
87+
},
88+
},
6589
},
6690
},
67-
})
91+
})

‎LICENSE‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Apache License
22
Version 2.0, January 2004
33
http://www.apache.org/licenses/
44

5-
Copyright 2026 {{ORG_DISPLAY_NAME}}
5+
Copyright 2026 DDD-4-Java
66

77
Licensed under the Apache License, Version 2.0 (the "License");
88
you may not use this file except in compliance with the License.
@@ -14,4 +14,4 @@ Apache License
1414
distributed under the License is distributed on an "AS IS" BASIS,
1515
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1616
See the License for the specific language governing permissions and
17-
limitations under the License.
17+
limitations under the License.

‎en/guide/contributing.md‎

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,35 @@
1-
# Contributing Guide
1+
# Contributing
22

3-
Welcome to contribute to DDD-4-Java!
3+
## Choose the right repository first
44

5-
## Submit a PR
5+
Submit bugs, features, and documentation changes to the repository that owns the capability. Change this Pages site only for cross-project catalogs, navigation, or organization-level guidance.
66

7-
1. Fork the target repository
8-
2. Create a feature branch (`git checkout -b feat/xxx`)
9-
3. Commit changes (`git commit -m "feat: xxx"`)
10-
4. Push (`git push origin feat/xxx`)
11-
5. Create a Pull Request
7+
## Suggested workflow
128

13-
## Report Issues
9+
1. Read the target README, CONTRIBUTING, AGENTS.md, and license.
10+
2. Add a test or reproducible case before changing behavior.
11+
3. Create a focused branch and keep the change to one concern.
12+
4. Run the repository’s own formatting, static analysis, tests, and build gates.
13+
5. Describe motivation, boundaries, verification, and compatibility impact in the PR.
1414

15-
Use the [Issues](https://github.com/ddd-4-java) page of the corresponding repository.
15+
```bash
16+
git clone https://github.com/ddd-4-java/<repository>.git
17+
cd <repository>
18+
git switch -c feat/<short-topic>
19+
```
1620

17-
## Code of Conduct
21+
## Common gates
1822

19-
Follow GitHub's community guidelines: professional, inclusive, respectful.
23+
```bash
24+
./mvnw clean verify
25+
```
26+
27+
## Update this site
28+
29+
```bash
30+
cd ddd-4-java.github.io
31+
npm install
32+
npm run docs:build
33+
```
34+
35+
Do not copy versions or counts into the site unless they are supported by source, manifests, releases, or the current repository state.

‎en/guide/ecosystem.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Ecosystem architecture and boundaries
2+
3+
This diagram describes repository and runtime responsibilities. It does not imply that every node is a stable release; check the catalog for status.
4+
5+
```mermaid
6+
flowchart TB
7+
APP["业务应用 / Business application"] --> RUNTIME["运行时适配 / Runtime adapters"]
8+
RUNTIME --> BOOT["ddd4j-boot"]
9+
RUNTIME --> JVL["ddd4j-javalin"]
10+
RUNTIME --> QRK["ddd4j-quarkus"]
11+
BOOT --> CORE["ddd4j framework-neutral core"]
12+
JVL --> CORE
13+
QRK --> CORE
14+
CORE --> DDD["Aggregate · Repository · Domain Event"]
15+
CORE --> CQRS["Command · Query · Projection"]
16+
CORE --> SPI["Data · MQ · Web · Auth · Cache SPI"]
17+
```
18+
19+
## Verified boundaries
20+
21+
- The five implementation repositories are currently private and under active restructuring; no public Maven artifact is advertised yet.
22+
- The local ddd4j baseline targets Java 17 and separates plain Java contracts from runtime-specific auto-configuration.
23+
- The module set covers aggregates, repositories, typed queries, domain events, CQRS, architecture rules, data, messaging, web, auth, and cache abstractions.
24+
25+
## Suggested reading order
26+
27+
1. Find the entry point closest to your use case in the diagram.
28+
2. Confirm whether the repository is public, a private preview, or archived.
29+
3. Open its README and confirm API, version, tests, and license.
30+
4. Run the smallest verification from Getting Started before business integration.

‎en/guide/getting-started.md‎

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,27 @@
1-
# Getting Started
1+
# Getting started
22

3-
Welcome to DDD-4-Java!
3+
This guide includes only entry points supported by the current repository state. When versions, access, or release status are uncertain, examples explicitly use Git revisions, source builds, or status checks.
44

5-
## What is this?
5+
## 1. Check release status first
66

7-
This organization hosts a collection of Rust crates / repositories focused on **[DDD Architecture for Java]**.
7+
There is no public Maven coordinate yet. Inspect repository visibility and do not copy placeholder versions.
88

9-
## How to use
9+
```bash
10+
gh repo list ddd-4-java --visibility public
11+
```
1012

11-
1. Browse the [Repositories list](/en/repositories) to see all available projects
12-
2. Pick the crate you need
13-
3. Follow the README instructions in each repository for integration
13+
## 2. Private preview
1414

15-
## Feedback & Support
15+
Organization members can use the branch, JDK, and Maven instructions in each private repository. Public users should follow release announcements.
1616

17-
- 🐛 **Bug reports**: [GitHub Issues](https://github.com/ddd-4-java/.github/issues)
18-
- 💬 **Discussions**: [GitHub Discussions](https://github.com/orgs/ddd-4-java/discussions)
19-
- 📧 **Email**: partmeai@gmail.com
17+
```bash
18+
git clone https://github.com/ddd-4-java/ddd4j.git
19+
cd ddd4j
20+
./mvnw -version
21+
```
2022

21-
---
23+
## Next steps
2224

23-
> This document is auto-generated. For detailed API, see each repository's README.
25+
- [Understand how projects relate](/en/guide/ecosystem)
26+
- [Browse the full repository catalog](/en/repositories)
27+
- [Prepare a contribution](/en/guide/contributing)

‎en/guide/license.md‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
1-
# License
1+
# License notes
22

3-
All projects in this organization are licensed under **Apache License 2.0**.
3+
## This site
44

5-
```
6-
Apache License
7-
Version 2.0, January 2004
8-
http://www.apache.org/licenses/
5+
The source of this Pages site is governed by the root [LICENSE](https://github.com/ddd-4-java/ddd-4-java.github.io/blob/main/LICENSE).
6+
7+
## Other organization projects
8+
9+
Do not assume one license covers the whole organization. Individual repositories may use Apache-2.0, MIT, MIT OR Apache-2.0, LGPL, or other terms. Read the target LICENSE before depending on, copying, or distributing it.
10+
11+
```bash
12+
git clone https://github.com/ddd-4-java/<repository>.git
13+
cd <repository>
14+
ls LICENSE* COPYING* 2>/dev/null
915
```
1016

11-
See each repository's LICENSE file for the full text.
17+
> A README badge or catalog summary does not replace the full license text.

‎en/index.md‎

Lines changed: 40 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,55 @@
11
---
22
layout: home
3-
title: Home
3+
title: DDD-4-Java
44
hero:
55
name: "DDD-4-Java"
6-
text: "DDD Architecture for Java"
7-
tagline: "Base classes for Domain-Driven Design (DDD) / CQRS / Event Sourcing in the Java ecosystem"
6+
text: "Engineering foundations for Java domain models"
7+
tagline: "Framework-neutral DDD, CQRS, and event-driven building blocks with runtime adapters for Spring Boot, Javalin, and Quarkus."
88
actions:
99
- theme: brand
10-
text: Get Started
10+
text: Get started
1111
link: /en/guide/getting-started
1212
- theme: alt
13-
text: View Repositories
13+
text: Repository catalog
1414
link: /en/repositories
15+
- theme: alt
16+
text: Ecosystem architecture
17+
link: /en/guide/ecosystem
1518
features:
16-
- icon: 🚀
17-
title: High-Frequency Tools
18-
details: Practical Rust crates for enterprise-grade applications
19-
- icon: 📦
20-
title: Type Safe
21-
details: Compile-time error catching with Rust's strong type system
22-
- icon: 🔧
23-
title: Production Ready
24-
details: Full test coverage, CI/CD, complete documentation
19+
- icon: 🏛️
20+
title: Contracts vs runtimes
21+
details: Domain contracts stay framework-neutral; Spring Boot, Javalin, and Quarkus bind them in adapter layers.
22+
- icon: 🧭
23+
title: Three modelling tracks
24+
details: Choose lightweight CRUD, rich aggregates, or CQRS/Event Sourcing according to domain complexity.
25+
- icon: 🚧
26+
title: Transparent maturity
27+
details: Private restructuring, public release, and Maven coordinates are reported separately.
2528
---
2629

27-
## About
30+
## What exists today
31+
32+
- **0** public projects
33+
- **5** private previews
34+
- Catalog refreshed **2026-07-22**
35+
36+
- The five implementation repositories are currently private and under active restructuring; no public Maven artifact is advertised yet.
37+
- The local ddd4j baseline targets Java 17 and separates plain Java contracts from runtime-specific auto-configuration.
38+
- The module set covers aggregates, repositories, typed queries, domain events, CQRS, architecture rules, data, messaging, web, auth, and cache abstractions.
39+
40+
> This site cross-checks the repositories currently visible on GitHub with local source workspaces. Availability is governed by each repository README, releases, and license.
41+
42+
## Choose an entry point
2843

29-
Base classes for Domain-Driven Design (DDD) / CQRS / Event Sourcing in the Java ecosystem
44+
| Goal | Next step |
45+
|---|---|
46+
| Understand the ecosystem | [Read architecture and boundaries](/en/guide/ecosystem) |
47+
| Choose a concrete project | [Browse the repository catalog](/en/repositories) |
48+
| Install or run something | [Open the getting-started guide](/en/guide/getting-started) |
49+
| Submit a fix or capability | [Read the contributing guide](/en/guide/contributing) |
3050

31-
## Quick Links
51+
## Organization links
3252

33-
- [GitHub Organization](https://github.com/ddd-4-java)
34-
- [.github profile README](https://github.com/ddd-4-java/.github/blob/main/profile/README.md)
53+
- [GitHub](https://github.com/ddd-4-java)
54+
- [All repositories](https://github.com/orgs/ddd-4-java/repositories)
55+
- [This site source](https://github.com/ddd-4-java/ddd-4-java.github.io)

0 commit comments

Comments
 (0)