Skip to content

Commit a158e44

Browse files
committed
fix path for readme
Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com>
1 parent 57f4c89 commit a158e44

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

docs/DEVELOPMENT.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ See `docs/src/data/template/image-template.yml` for all available fields.
6565
### Step 2: Regenerate
6666

6767
```bash
68-
cd docs/src && python main.py --verbose
68+
python docs/src/main.py --verbose
6969
```
7070

7171
---
@@ -76,7 +76,7 @@ Add `ga` and `eop` fields to image configs for repositories that appear in suppo
7676

7777
```yaml
7878
ga: "2025-10-15" # General Availability date
79-
eop: "2026-10-15" # End of Patch date
79+
eop: "2035-10-15" # End of Patch date
8080
```
8181

8282
**Version Consolidation:**
@@ -229,4 +229,4 @@ For any changes required to the tutorial pages, create a new PR in
229229
| "Display name not found" | Add repository to `display_names` in `global.yml` |
230230
| "Inconsistent dates" | Ensure all images in same framework group/version have identical GA/EOP |
231231
| Images not appearing | Check repository is in `table_order` |
232-
| Release notes not generating | Ensure `announcements` and `packages` fields are present |
232+
| Release notes not generating | Ensure `announcements` and `packages` fields are present |

docs/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,23 @@ uv pip install -r docs/requirements.txt
1818

1919
Run the generation system without serving:
2020
```bash
21-
cd docs/src && python main.py --verbose
21+
python docs/src/main.py --verbose
2222
```
2323
This clones the `tutorials/` repository and generates markdown files in `reference/` and `releasenotes/` directories.
2424

2525
Generation flags:
2626
```bash
27-
python main.py --available-images-only
28-
python main.py --support-policy-only
29-
python main.py --release-notes-only
30-
python main.py --index-only
27+
python docs/src/main.py --available-images-only
28+
python docs/src/main.py --support-policy-only
29+
python docs/src/main.py --release-notes-only
30+
python docs/src/main.py --index-only
3131
```
3232

3333
### Serving
3434

3535
Use `mkdocs serve` to generate documentation and serve the website:
3636
```bash
37-
cd docs && mkdocs serve
37+
mkdocs serve
3838
```
3939
The site is typically available at `http://127.0.0.1:8000/deep-learning-containers/` - check the command output for the actual URL.
4040

0 commit comments

Comments
 (0)