Skip to content

Conversation

@molbap
Copy link
Contributor

@molbap molbap commented Nov 20, 2025

What does this PR do?

Checked out the contributing guide, found 2 dead links

@molbap molbap requested a review from zucchini-nlp November 20, 2025 10:24
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Copy link
Member

@zucchini-nlp zucchini-nlp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, the links work for me and lead to correct sections from guidelines 🤔 Do we prefer a full path for some reason?

@molbap
Copy link
Contributor Author

molbap commented Nov 20, 2025

it's that it does not work from https://github.com/huggingface/transformers/blob/main/CONTRIBUTING.md is all and it tends to be my first entrypoint 😆 and most other links there do work, haven't checked all though

@zucchini-nlp
Copy link
Member

Ah I see, though it will stop working from docs after this PR because it has to be without the .md suffix for it 🥲 Not sure what's the correct way to make it work in both places

https://moon-ci-docs.huggingface.co/docs/transformers/pr_42296/en/contributing#do-you-want-to-implement-a-new-model

@molbap
Copy link
Contributor Author

molbap commented Nov 20, 2025

no idea either, cc @stevhliu here please 🙏

@stevhliu
Copy link
Member

Hmm, I think we can either:

  • remove the symlink between the CONTRIBUTING.md on the repo and the docs
  • modify the doc-builder to accept the .md extension (this is probably the best since it requires less maintenance)

wdyt?

@molbap
Copy link
Contributor Author

molbap commented Nov 21, 2025

Yes why not go for the doc-builder change!

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.

5 participants