Skip to content

Commit 5eef9b2

Browse files
committed
update developers.md
Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com>
1 parent 4a652d0 commit 5eef9b2

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

docs/DEVELOPMENT.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ docs/
4242
└── mkdocs.yml
4343
```
4444

45-
* * *
45+
______________________________________________________________________
4646

4747
## Adding a New Image
4848

@@ -74,7 +74,7 @@ See `docs/src/data/template/image-template.yml` for all available fields.
7474
cd docs/src && python main.py --verbose
7575
```
7676

77-
* * *
77+
______________________________________________________________________
7878

7979
## Adding Support Policy Dates
8080

@@ -87,7 +87,7 @@ eop: "2026-10-15" # End of Patch date
8787

8888
**Validation:** All images in the same framework group with the same version must have identical GA/EOP dates.
8989

90-
* * *
90+
______________________________________________________________________
9191

9292
## Adding Release Notes
9393

@@ -114,6 +114,7 @@ Release notes are generated automatically for images with `announcement` and `pa
114114
### Adding New Optional Sections
115115

116116
1. Add section to image config under `optional`:
117+
117118
```yaml
118119
optional:
119120
known_issues:
@@ -122,21 +123,23 @@ Release notes are generated automatically for images with `announcement` and `pa
122123
- "This image will be deprecated..."
123124
```
124125

125-
2. Add display name to `global.yml`:
126+
1. Add display name to `global.yml`:
127+
126128
```yaml
127129
display_names:
128130
deprecation_notice: "Deprecation Notice"
129131
```
130132

131133
Sections render in YAML order as bullet lists.
132134

133-
* * *
135+
______________________________________________________________________
134136

135137
## Adding a New Repository
136138

137139
1. Create directory: `docs/src/data/<repository>/`
138140

139-
2. Create table config `docs/src/tables/<repository>.yml`:
141+
1. Create table config `docs/src/tables/<repository>.yml`:
142+
140143
```yaml
141144
columns:
142145
- field: framework_version
@@ -147,7 +150,8 @@ Sections render in YAML order as bullet lists.
147150
header: "Example URL"
148151
```
149152

150-
3. Add to `docs/src/global.yml`:
153+
1. Add to `docs/src/global.yml`:
154+
151155
```yaml
152156
display_names:
153157
my-repo: "My Repository"
@@ -156,7 +160,7 @@ Sections render in YAML order as bullet lists.
156160
- my-repo
157161
```
158162

159-
* * *
163+
______________________________________________________________________
160164

161165
## Editing Table Columns
162166

@@ -173,7 +177,7 @@ columns:
173177

174178
**Available fields:** `framework_version`, `python`, `cuda`, `sdk`, `accelerator`, `platform`, `os`, `example_url`, `tag`, `release_note_link`
175179

176-
* * *
180+
______________________________________________________________________
177181

178182
## Legacy Support Data
179183

@@ -186,7 +190,7 @@ pytorch:
186190
eop: "2025-10-29"
187191
```
188192

189-
* * *
193+
______________________________________________________________________
190194

191195
## Global Configuration
192196

@@ -198,7 +202,7 @@ pytorch:
198202
- **table_order:** Order of tables in available_images.md
199203
- **platforms/accelerators:** Display mappings
200204

201-
* * *
205+
______________________________________________________________________
202206

203207
## Running Generation
204208

@@ -215,7 +219,7 @@ python main.py --release-notes-only
215219
cd docs && mkdocs serve
216220
```
217221

218-
* * *
222+
______________________________________________________________________
219223

220224
## Troubleshooting
221225

0 commit comments

Comments
 (0)