Wondering if the website documentation is correctly updated

Site Feedback
1

Hey there, I’m Benjamin, beginner developer learning about smoleagents.

My goal is to learn from the latest documentation, and I have noticed that sometimes, your Github documentation and website documentation are different.

Example:

  1. I am reading this documentation on your website: Building good agents
  2. At the bottom of the page, I click “update on Github”. This leads to a broken link “…/tutorials/building_good_agents.md”.
  3. Only when I add an “x” to the link - meaning “.mdx”, I get directed to the Github version of the original documentation.
  4. The issue: it looks like the Github content is different than your website documents.

Which one is the correct documentation? is this a bug or a feature?

1 Like
2

I’m not involved with Hugging Face, but I think the github version is the correct one, or the most up-to-date one.

It seems that Hugging Face generally uses github to manage documentation before release. Each library has its own github, and each website-related thing has its own github for each project.

1 Like