Skip to content

Commit 43688b2

Browse files
authored
feat: add field for project design documentation (#163)
* feat: add field for project design documentation Signed-off-by: Eddie Knight <knight@linux.com> * typofix Signed-off-by: Eddie Knight <knight@linux.com> --------- Signed-off-by: Eddie Knight <knight@linux.com>
1 parent bf996ad commit 43688b2

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

docs/schema.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@ the project's documentation resources
137137
Optional:
138138

139139
- `code-of-conduct`
140+
- `design`
140141
- `detailed-guide`
141142
- `quickstart-guide`
142143
- `release-process`
@@ -153,6 +154,14 @@ URL to the document outlining contributor and user conduct guidelines.
153154

154155
---
155156

157+
#### `project.documentation.design` (optional)
158+
159+
URL to design documents such as architecture or design decisions.
160+
161+
- **Type**: [URL]
162+
163+
---
164+
156165
#### `project.documentation.detailed-guide` (optional)
157166

158167
URL to more extensive or advanced documentation.

spec/schema.cue

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,9 @@ import (
137137

138138
// ProjectDocumentation contains links to various documents related to the project, including detailed guides, code of conduct, quickstart guides, release processes, support policies, and signature verification.
139139
#ProjectDocumentation: {
140+
// URL to design documentation for this project.
141+
design?: #URL @go(Design,type=*URL)
142+
140143
// URL to more extensive or advanced documentation.
141144
"detailed-guide"?: #URL @go(DetailedGuide,type=*URL)
142145

spec/schema.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ the project's documentation resources
130130
Optional:
131131

132132
- `code-of-conduct`
133+
- `design`
133134
- `detailed-guide`
134135
- `quickstart-guide`
135136
- `release-process`
@@ -146,6 +147,14 @@ URL to the document outlining contributor and user conduct guidelines.
146147

147148
---
148149

150+
#### `project.documentation.design` (optional)
151+
152+
URL to design documents such as architecture or design decisions.
153+
154+
- **Type**: [URL]
155+
156+
---
157+
149158
#### `project.documentation.detailed-guide` (optional)
150159

151160
URL to more extensive or advanced documentation.

0 commit comments

Comments
 (0)