Skip to content

Commit 50caee4

Browse files
committed
update steering
Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com>
1 parent 8f7eb46 commit 50caee4

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

.kiro/steering/docs.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,17 @@ The documentation uses an automatic generation system for `index.md`, `available
1414

1515
### Homepage Generation (README.md → index.md)
1616

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.
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. HTML elements use `align="center"` (not `style="text-align:center"`) for GitHub compatibility.
1818

1919
`docs/index.md` is **generated** (listed in `.gitignore`) by `generate_index()` which:
2020

2121
1. Reads `README.md` content
2222
1. Strips `SITE_URL` prefix from absolute URLs to produce relative links (e.g., `reference/available_images/`)
23+
1. Expands the single README logo into dual MkDocs theme-aware logos (`#only-light`/`#only-dark`)
2324
1. Wraps content in `templates/index.template.md` (adds MkDocs frontmatter)
2425

26+
**Logo handling:** README.md contains a single light logo (`AWS_logo_RGB.svg`) so GitHub shows one image. `generate_index()` uses `str.replace()` to expand it into two `<img>` tags with `#only-light` and `#only-dark` fragment identifiers that MkDocs Material uses for theme switching.
27+
2528
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.
2629

2730
To update the homepage, edit `README.md` and regenerate: `python docs/src/main.py --index-only`

0 commit comments

Comments
 (0)