Skip to content
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

Port and review docs from internal repository #1

Merged
merged 2 commits into from
Oct 21, 2024
Merged

Conversation

alvarobartt
Copy link
Member

Description

This PR ports the docs from an internal repository, and also reviews and updates some of those with minor updates (listed below).

  • Use <Tip> over ![NOTE] as those are rendered in hf.co/docs
  • Extend docs/source/how-to/cloud/aws.mdx with up-to-date information from https://github.com/huggingface/hugs-helm-chart
  • Update docs/source/how-to/kubernetes.mdx on Helm Chart usage (updated to be compliant with 0.0.3)
  • Fix formatting on some files e.g. multiple extra line-breaks, table formatting, or inconsistent usage of - and * for bullet-point listing

@alvarobartt alvarobartt self-assigned this Oct 21, 2024
@alvarobartt alvarobartt added the documentation Improvements or additions to documentation label Oct 21, 2024
@alvarobartt
Copy link
Member Author

FYI I have the model cards locally, but was not sure whether we want to push those too or not, if we were about to push those, how should we link those? Do you have anything in mind for those? @philschmid, thanks in advance 🤗

@philschmid philschmid merged commit 6aadfe2 into main Oct 21, 2024
1 check passed
@philschmid philschmid deleted the port-docs branch October 21, 2024 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants