Skip to content

docs: repoint Unit 1 README section links to the published course pages - #751

Open
yetuge wants to merge 1 commit into
huggingface:mainfrom
yetuge:fix/unit1-readme-dead-links
Open

yetuge wants to merge 1 commit into
huggingface:mainfrom
yetuge:fix/unit1-readme-dead-links

Conversation

@yetuge

@yetuge yetuge commented Sep 23, 2026

Copy link
Copy Markdown

Fixes #749

What

Repoint the Unit 1 section links in all six units/<lang>/unit1/README.md files (en, es, fr, ko, ru-RU, zh-CN) from the removed numbered section files to the published course pages under https://hf.co/learn/agents-course/unit1/<slug>.

Why

The section tables link to numbered .md files (1_definition_of_an_agent.md … 11_simple_use_case.md) that were removed in the course restructure — 77 dead relative links in total (11 per language, 22 in zh-CN whose table appears twice). Following the maintainer's direction in #749, the published pages now live under /learn/agents-course/, so each section link is remapped to its published slug.

Mapping

Source of truth: each language's _toctree.yml (verified identical slugs across all six languages).

Old (dead) New (published slug)
1_definition_of_an_agent.md what-are-agents
2_explain_llms.md what-are-llms
3_messages_and_special_tokens.md messages-and-special-tokens
4_dummy_agent_library.md dummy-agent-library
5_tools.md tools
6_agent_steps_and_structure.md agent-steps-and-structure
7_thoughts.md thoughts
8_actions.md actions
9_observations.md observations
10_quizz.md final-quiz
11_simple_use_case.md tutorial

Verification

  • All four spot-checked target URLs return HTTP 200 (introduction, what-are-agents, final-quiz, tutorial); the URL form matches each README's own existing intro link (https://hf.co/learn/agents-course/unit1/introduction).
  • Post-fix link audit across the repo's markdown: 0 broken relative links (was 77).
  • Rewritten link count matches the issue's reported count exactly (77).
  • The section tables remain inside their existing HTML comment blocks exactly as before — only the link targets change. No content, structure, or rendering behavior is modified.
  • zh-CN's duplicated table (22 links) is fully covered.

AI assistance

Prepared with AI assistance (Claude Code via ZCode): the original 77-dead-link audit, the old→new mapping derived from the _toctree.yml files, and the URL verification; the human account owner reviewed and authorized this change.

All six units/<lang>/unit1/README.md files linked to numbered section
files (1_definition_of_an_agent.md ... 11_simple_use_case.md) that were
removed in the course restructure — 77 dead relative links in total.
The content now lives on the published course under
https://hf.co/learn/agents-course/unit1/<slug>, matching the URL pattern
already used by each README's own intro link and confirmed by a
maintainer on issue huggingface#749.

Remap each section link to its published slug (source of truth: the
per-language _toctree.yml; 10_quizz.md maps to final-quiz, the
consolidated unit quiz; 11_simple_use_case.md maps to tutorial):

  1_definition_of_an_agent.md      -> what-are-agents
  2_explain_llms.md                -> what-are-llms
  3_messages_and_special_tokens.md -> messages-and-special-tokens
  4_dummy_agent_library.md         -> dummy-agent-library
  5_tools.md                       -> tools
  6_agent_steps_and_structure.md   -> agent-steps-and-structure
  7_thoughts.md                    -> thoughts
  8_actions.md                     -> actions
  9_observations.md                -> observations
  10_quizz.md                      -> final-quiz
  11_simple_use_case.md            -> tutorial

All targets verified live (HTTP 200). Link audit now reports 0 broken
relative links. The section table stays inside the existing HTML comment
block, exactly as before — only the link targets change. No content,
structure, or rendering behavior is modified.
@yetuge

yetuge commented Oct 14, 2026

Copy link
Copy Markdown
Author

Hi @Stefan-Dressler — gentle ping on this one (three weeks old): it repoints all 77 dead Unit 1 section links to the published /learn/agents-course/ pages, per your direction on #749. Thanks for maintaining the course!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Unit 1 READMEs (all 6 languages) link to 11 section files that no longer exist (77 dead links)

1 participant