Skip to content

Conversation

Dhiraj309
Copy link

PR Title

[docs] improve Quickstart navigation and usage flow

Summary

This PR improves the Quickstart documentation by:

  • Adding a "What’s next?" section with direct links to key resources (Installation, Quickstart, Usage Guides, 8-bit optimizers).
  • Ensuring links are consistent with the documentation structure (installation.mdx, quickstart.mdx, optimizers.mdx, etc.).
  • Polishing navigation flow to help new users move smoothly from setup to advanced usage.

Why

Currently, Quickstart ends abruptly without clear directions. New users may struggle to discover next steps or related docs. This PR aligns Quickstart with Hugging Face-style documentation by giving readers a clear path forward.

Impact

  • Improves user onboarding experience.
  • Increases visibility of important guides and optimizers.
  • Keeps docs consistent and beginner-friendly.

Notes

  • Pre-commit hooks were run (pre-commit run --all-files), ensuring formatting and style compliance.
  • Commit messages follow the existing convention for docs updates.

This small but impactful change helps streamline the documentation experience, making it easier for the community to explore bitsandbytes efficiently.

@matthewdouglas matthewdouglas added the Documentation Improvements or additions to documentation label Aug 25, 2025
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.

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