You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@magpie.apache.org by "potiuk (via GitHub)" <gi...@apache.org> on 2026/07/09 09:32:25 UTC

[PR] fix(docs,landing): split Training into its own docs section; add landing link [magpie-site]

potiuk opened a new pull request, #74:
URL: https://github.com/apache/magpie-site/pull/74

   ## What & why
   
   The `education/training` module lives under
   `src/content/docs/education/training/`, but the docs sidebar folded it into the
   **Education** group and labelled its README generically. The result:
   
   - **Education** showed **two "Overview" links** (its own README + training's), and
   - the five training lessons landed in the Education list.
   
   ## Changes
   
   **Docs — promote `education/training` to its own section** (`DocsLayout.astro`
   sidebar + `docs/index.astro` index):
   - A `NESTED_GROUPS` set surfaces `education/training` under its own **Training**
     heading.
   - Group-overview detection now keys on the README's **directory** rather than
     path depth, so a section's README is recognised at any nesting level
     (`tools/<name>/readme` stays a per-tool page, not a group overview).
   - Result: **Education** = one Overview + its chapters; **Training** = its own
     Overview + lessons 01–05, ordered by the module README.
   
   **Landing page** (`ImmersiveGradientHero.tsx`):
   - Add a **"Run it as a training course"** CTA (→ `/docs/education/training/readme`)
     next to "Explore the education stream".
   
   **New guard hook** (`scripts/check-landing-education.py`, wired as
   `landing-education-sync`):
   - Deterministic, stdlib-only Python prek hook that fails if any education
     chapter under `src/content/docs/education/*.md` (except README; `training/`
     excluded) is **not** linked from the landing hero, or if the hero links a
     page that no longer exists. Scoped to the education docs, the hero, and the
     script itself.
   
   ## Verification
   - `npm run build` clean (121 pages).
   - Rendered sidebar confirmed: Education → `Overview` + 13 chapters; Training →
     `Overview` + 5 lessons.
   - `landing-education-sync` passes; verified it fails on both a missing chapter
     and a dangling link.
   
   🤖 Generated with [Claude Code](https://claude.com/claude-code)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@magpie.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] fix(docs,landing): split Training into its own docs section; add landing link [magpie-site]

Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk merged PR #74:
URL: https://github.com/apache/magpie-site/pull/74


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@magpie.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org