docs: enhanced API docs with intro and links

[YiyanZhai]

Add introduction to FlashInfer-Bench Python API documentation.

Summary by CodeRabbit

• Documentation
  • Updated API index with a friendlier welcome title and a descriptive intro summarizing purpose and workflow.
  • Added a top info row linking external resources (Blog post, GitHub, Slack) and expanded the API Reference table of contents with three new topics.
  • Inserted a Slack invite/link in the README and clarified the Slack channel reference in site docs.

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Updated documentation pages: docs/api/index.md rewritten with a welcoming intro, top links row, descriptive paragraph, and revised toctree; README.md and docs/index.mdx text adjusted to clarify Slack invite/channel. No code or API signatures changed.

Changes

Cohort / File(s)	Summary
API index update docs/api/index.md	Replaced the main header with a welcoming introduction, added a top information row with external links (Blog Post, GitHub, Slack), inserted a descriptive paragraph about FlashInfer‑Bench, and updated the toctree caption to "API Reference" including rst/apply, rst/tracing, and rst/schema.
Top-level docs/README text tweaks README.md, docs/index.mdx	Adjusted Slack invite text/links: README.md adds a Slack invite link in the header area; docs/index.mdx clarifies the Slack join reference by specifying the #flashinfer-bench channel. No functional code changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Review focus:
  • docs/api/index.md — verify link targets, toctree entries, and markdown rendering.
  • README.md & docs/index.mdx — confirm Slack link formatting and correct channel reference.

Possibly related PRs

• docs: python api reference #109 — Modifies docs/api/index.md (API index / toctree); directly related to these doc changes.

Poem

🐰 A hop, a link, a friendly line,
I tuned the docs till they align,
Apply, trace, schema now in view,
Slack and blog links fresh and new,
— a rabbit’s nibble, quick and fine 🥕

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main changes: enhanced API documentation with introduction and external links.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch yiyan-dev/api

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7c906c9 and 64500ea.

📒 Files selected for processing (3)

• README.md (1 hunks)
• docs/api/index.md (1 hunks)
• docs/index.mdx (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• README.md
• docs/api/index.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: Run unit tests on ubuntu-latest and Python 3.11
• GitHub Check: Run unit tests on ubuntu-latest and Python 3.10
• GitHub Check: Run unit tests on ubuntu-latest and Python 3.13
• GitHub Check: Run unit tests on ubuntu-latest and Python 3.12

🔇 Additional comments (1)

docs/index.mdx (1)

19-19: Approved: Clear and consistent documentation improvement.

The addition of "(#flashinfer-bench channel)" clarifies which channel users should join and maintains consistency with the existing link list formatting.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Summary of Changes

Hello @YiyanZhai, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the FlashInfer-Bench Python API documentation by integrating a welcoming introduction, essential external links, and a concise overview of the project's mission. These additions are designed to provide new users with a clearer understanding of FlashInfer-Bench's capabilities and easier access to related resources, thereby improving the overall user experience of the documentation.

Highlights

• Documentation Enhancement: The Python API documentation for FlashInfer-Bench now includes an introductory section to welcome users.
• External Links Added: Direct links to the FlashInfer-Bench blog post, GitHub repository, and Slack channel have been added for easy access to related resources.
• Project Overview: A descriptive paragraph has been incorporated to explain the core purpose and capabilities of FlashInfer-Bench, providing a quick understanding for new users.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request improves the landing page for the Python API documentation by adding an introduction and helpful links. The changes make the documentation more welcoming and informative. My review includes a couple of suggestions to further enhance clarity and navigation: one to make the page title more conventional for technical docs, and another to add a 'Get Started' link for easier onboarding of new users.

[gemini-code-assist]

These links are a great addition. To further improve navigation for users who might land directly on this API page, I suggest adding a link to the 'Get Started' guide. This would provide a clear entry point for new users and improve consistency with other project entry points like the README.md.

Suggested change

	[Blog Post](https://flashinfer.ai/2025/10/21/flashinfer-bench.html) | [GitHub](https://github.com/flashinfer-ai/flashinfer-bench/) | [Join FlashInfer Slack](https://join.slack.com/t/flashinfer/shared_invite/zt-379wct3hc-D5jR~1ZKQcU00WHsXhgvtA)
	[Get Started](../start/quick_start) | [Blog Post](https://flashinfer.ai/2025/10/21/flashinfer-bench.html) | [GitHub](https://github.com/flashinfer-ai/flashinfer-bench/) | [Join FlashInfer Slack](https://join.slack.com/t/flashinfer/shared_invite/zt-379wct3hc-D5jR~1ZKQcU00WHsXhgvtA)

[Ubospica]

LGTM! Could you also add

[Slack (Join channel #flashinfer-bench)](https://join.slack.com/t/flashinfer/shared_invite/zt-379wct3hc-D5jR~1ZKQcU00WHsXhgvtA)

to the header of README.md?

[Ubospica]

Commits must have verified signatures.

Please use git commit -S to sign the commit.

[coderabbitai]

Actionable comments posted: 0

♻️ Duplicate comments (1)

docs/api/index.md (1)

1-1: Title: Address previous feedback on scannability.

A past review suggested simplifying the title to # FlashInfer-Bench Python API for better documentation scannability and alignment with standard practices. This suggestion remains unresolved in the current version.

Consider applying this change:

-# Welcome to FlashInfer-Bench Python API documentation!
+# FlashInfer-Bench Python API

🧹 Nitpick comments (1)

docs/api/index.md (1)

3-3: Add "Get Started" link for improved navigation.

A previous review suggested including a "Get Started" link to provide new users with a clear entry point and improve consistency with other project entry points. Consider adding it alongside the existing external links.

-[Blog Post](https://flashinfer.ai/2025/10/21/flashinfer-bench.html) | [GitHub](https://github.com/flashinfer-ai/flashinfer-bench/) | [Slack (Join channel #flashinfer-bench)](https://join.slack.com/t/flashinfer/shared_invite/zt-379wct3hc-D5jR~1ZKQcU00WHsXhgvtA)
+[Get Started](../start/quick_start) | [Blog Post](https://flashinfer.ai/2025/10/21/flashinfer-bench.html) | [GitHub](https://github.com/flashinfer-ai/flashinfer-bench/) | [Slack (Join channel #flashinfer-bench)](https://join.slack.com/t/flashinfer/shared_invite/zt-379wct3hc-D5jR~1ZKQcU00WHsXhgvtA)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a64ed28 and 7e2843f.

📒 Files selected for processing (1)

• docs/api/index.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: Run unit tests on ubuntu-latest and Python 3.13
• GitHub Check: Run unit tests on ubuntu-latest and Python 3.11
• GitHub Check: Run unit tests on ubuntu-latest and Python 3.10
• GitHub Check: Run unit tests on ubuntu-latest and Python 3.12

🔇 Additional comments (2)

docs/api/index.md (2)

5-5: Clear and informative description.

The descriptive paragraph effectively communicates the purpose and value proposition of FlashInfer-Bench. This is a strong addition to the documentation.

---

7-14: Toctree structure looks good.

The updated toctree with the "API Reference" caption and new topic entries (rst/apply, rst/tracing, rst/schema) improves discoverability and organization.