Skip to content

fix path for readme #5651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sirutBuasai merged 1 commit into from
Feb 10, 2026
Merged

fix path for readme #5651

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ See `docs/src/data/template/image-template.yml` for all available fields.
### Step 2: Regenerate

```bash
cd docs/src && python main.py --verbose
python docs/src/main.py --verbose
```

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

```yaml
ga: "2025-10-15" # General Availability date
eop: "2026-10-15" # End of Patch date
eop: "2035-10-15" # End of Patch date
```

**Version Consolidation:**
Expand Down Expand Up @@ -229,4 +229,4 @@ For any changes required to the tutorial pages, create a new PR in
| "Display name not found" | Add repository to `display_names` in `global.yml` |
| "Inconsistent dates" | Ensure all images in same framework group/version have identical GA/EOP |
| Images not appearing | Check repository is in `table_order` |
| Release notes not generating | Ensure `announcements` and `packages` fields are present |
| Release notes not generating | Ensure `announcements` and `packages` fields are present |
12 changes: 6 additions & 6 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,23 @@ uv pip install -r docs/requirements.txt

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

Generation flags:
```bash
python main.py --available-images-only
python main.py --support-policy-only
python main.py --release-notes-only
python main.py --index-only
python docs/src/main.py --available-images-only
python docs/src/main.py --support-policy-only
python docs/src/main.py --release-notes-only
python docs/src/main.py --index-only
```

### Serving

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

Expand Down