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

[docs] Reorganize docs #1072

Merged
merged 5 commits into from
Feb 21, 2024
Merged

Conversation

stevhliu
Copy link
Contributor

@stevhliu stevhliu commented Feb 21, 2024

This PR reorganizes the current structure of the docs and consolidates all the installation instructions (compiling from source and non-PyTorch CUDA versions) into a single doc so users can easily find everything.

cc @Titus-von-Koeller

@Titus-von-Koeller
Copy link
Collaborator

Strange that the workflow didn't post a link to the docs page of the PR. It also doesn't exist actually. A functioning example would be here, whereas the page of this PR doesn't exist: https://moon-ci-docs.huggingface.co/docs/bitsandbytes/pr_1072/en/index

Copy link

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.

@Titus-von-Koeller
Copy link
Collaborator

Ok, rerunning the workflow solved it. Really strange, cc @younesbelkada, that there was a silent failure here, as the publishing workflow had displayed as green.

@younesbelkada
Copy link
Collaborator

Hmmm interesting, however I am able to see the changes in https://moon-ci-docs.huggingface.co/docs/bitsandbytes/pr_1072/en/index - i think all is good no?

@Titus-von-Koeller
Copy link
Collaborator

Thanks, this looks great. I just made a small tweak. I'll see if everything compiled correctly after going to sports and then merge it.

Thanks again for your work. Really great to have your collaboration on further improving the docs 🤗

@Titus-von-Koeller Titus-von-Koeller merged commit b0730f4 into bitsandbytes-foundation:main Feb 21, 2024
2 checks passed
@Titus-von-Koeller
Copy link
Collaborator

Titus-von-Koeller commented Feb 21, 2024

Thanks @stevhliu for your work! Made some small tweaks in the existing text that I became aware of when reviewing everything. I think this restructuring definitely improves the status quo. Looking forward to the next steps as well :)

@Titus-von-Koeller
Copy link
Collaborator

Hmmm interesting, however I am able to see the changes in https://moon-ci-docs.huggingface.co/docs/bitsandbytes/pr_1072/en/index - i think all is good no?

@younesbelkada Yeah, the thing is that the link gave back a 404 at first, even though the workflow for publishing had been green for a couple of days. The docs and the automatic post here in the PR linking to it only appeared when I triggered a rerun of the action.

I think it's a bit sup-optimal that the job can fail silently. At a quick glance I couldn't even figure out where the code is that is responsible to posting back to the PR. Maybe we should take a look when we get around to it.

@stevhliu stevhliu deleted the reorg branch February 21, 2024 21:58
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.

3 participants