You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+53Lines changed: 53 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,6 +41,59 @@ In short, when you submit code changes, your submissions are understood to be un
41
41
42
42
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/ardalis/CleanArchitecture/issues/new/choose); it's that easy!
43
43
44
+
## Contributing to Documentation
45
+
46
+
The project docs are a [Hugo](https://gohugo.io/) site located in the `/docs` folder and are published to [ardalis.github.io/CleanArchitecture](https://ardalis.github.io/CleanArchitecture/) automatically when changes to `docs/**` are merged to `main`.
47
+
48
+
### Adding or editing a page
49
+
50
+
All content lives under `docs/content/`. Each file is standard Markdown with a small YAML front matter block at the top:
51
+
52
+
```markdown
53
+
---
54
+
title: "My New Page"
55
+
weight: 25
56
+
---
57
+
58
+
Page content here.
59
+
```
60
+
61
+
-`title` — the label shown in the left navigation.
62
+
-`weight` — controls the sort order; lower numbers appear higher in the nav.
63
+
64
+
To add a **new section** (a collapsible group in the nav), create a subdirectory and add an `_index.md` inside it using the same front matter pattern.
65
+
66
+
Existing content sections for reference:
67
+
68
+
| Path | Purpose |
69
+
| --- | --- |
70
+
|`docs/content/getting-started.md`| Installation and first steps |
71
+
|`docs/content/design-decisions.md`| Goals and design rationale |
0 commit comments