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: .kiro/steering/docs.md
+19-3Lines changed: 19 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,13 +10,28 @@ Within this documentations page, website navigation through `.nav.yml` file shou
10
10
11
11
## Documentation Generation System
12
12
13
-
The documentation uses an automatic generation system for `available_images.md`, `support_policy.md`, and release notes.
13
+
The documentation uses an automatic generation system for `index.md`, `available_images.md`, `support_policy.md`, and release notes.
14
+
15
+
### Homepage Generation (README.md → index.md)
16
+
17
+
`README.md` at the repository root is the **source of truth** for the homepage. It uses hardcoded display names and absolute URLs to `SITE_URL` (`https://aws.github.io/deep-learning-containers/`) so it renders correctly on GitHub.
18
+
19
+
`docs/index.md` is **generated** (listed in `.gitignore`) by `generate_index()` which:
20
+
21
+
1. Reads `README.md` content
22
+
1. Strips `SITE_URL` prefix from absolute URLs to produce relative links (e.g., `reference/available_images/`)
23
+
1. Wraps content in `templates/index.template.md` (adds MkDocs frontmatter)
24
+
25
+
Internal doc links in README.md use trailing-slash format (e.g., `https://aws.github.io/deep-learning-containers/security/`). After SITE_URL stripping, these become relative directory-style links that MkDocs resolves automatically.
26
+
27
+
To update the homepage, edit `README.md` and regenerate: `python docs/src/main.py --index-only`
0 commit comments