-
Notifications
You must be signed in to change notification settings - Fork 581
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[API Reference docs] Remove git references from GitHub Action templates #813
Conversation
build_documentation
Action
The reference has been set to |
The documentation is not available anymore as the PR was closed or merged. |
@LysandreJik can we replace the comment left by @HuggingFaceDocBuilderDev by a github action whose |
Should the reference be |
I'd rather we stay coherent with the rest of the HF libraries which all provide the docs in a very accessible manner. Could you show me what you have in mind with a GitHub Action whose details would link to the artifacts? I believe we had something similar with CircleCI in the past, but none of the users were aware of it even if mentioned in the contributing guide.
The reference specified here is the reference to The CI currently does the following:
|
This is how it could look like, which you can see in this PR (scikit-learn/scikit-learn#23002), and it only compiles the changed documents, with links to the PR version vs the main (dev) version vs the latest stable release (we really don't have to implement all of that here). The The solution right now adds a comment (at least one I guess) to every PR, that's a ton of noise. HuggingFace is not a single community, and I think the community of each project should decide how to configure the tools they use rather than it being one solution for all. |
I understand. Would you be open to discussing this in a separate issue, as it's not linked to this PR; and to merge this PR so that we may have the docs deployed? |
This PR fixes the
build_documentation
as well as other doc building actions by removing the git references used previously. These were references to branches that have since been merged in the default branch.Closes #811