Skip to content

fix: fix quick start link and examples #100

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+15 −556
Open

fix: fix quick start link and examples #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f949039
clean
YiyanZhai Oct 24, 2025
99fb4a5
fix link
YiyanZhai Oct 24, 2025
fdddcc2
linting
YiyanZhai Oct 24, 2025
6ca7bd8
upd ci
YiyanZhai Oct 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ print(fib.__version__)

## Get Started

This [guide](https://bench.flashinfer.ai/docs/start/quick_start) shows you how to use FlashInfer-Bench python module with the FlashInfer-Trace dataset.
This [guide](https://bench.flashinfer.ai/docs/start/quickstart) shows you how to use FlashInfer-Bench python module with the FlashInfer-Trace dataset.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The link to the quick start guide has been changed to use quickstart, but the corresponding documentation file provided in the context is named quick_start.mdx. This inconsistency might lead to a broken link. If the URL path is derived from the filename, it should probably keep the underscore to match.

Suggested change
This [guide](https://bench.flashinfer.ai/docs/start/quickstart) shows you how to use FlashInfer-Bench python module with the FlashInfer-Trace dataset.
This [guide](https://bench.flashinfer.ai/docs/start/quick_start) shows you how to use FlashInfer-Bench python module with the FlashInfer-Trace dataset.


## FlashInfer Trace Dataset

Expand Down
4 changes: 2 additions & 2 deletions docs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Useful links:

## Next Steps

- Get Started: ./start/quick_start
- Get Started: ./start/quickstart
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Verify the updated Get Started path exists and is accessible.

The path was updated from ./start/quick_start to ./start/quickstart. Confirm that the documentation file exists at the new path and that the link renders correctly in the deployed documentation.

Run the following script to check for any remaining references to the old path in the codebase:

🏁 Script executed:

#!/bin/bash
# Description: Search for references to the old "quick_start" path in documentation and code.

# Search for old path pattern
rg -n 'quick_start|quick-start' --type md --type mdx --type ts --type js --type json

Length of output: 27

🏁 Script executed:

#!/bin/bash
# Description: Search for references to old "quick_start" path in docs and code (corrected).

# Search for old path pattern - omit mdx type since it's not recognized
echo "=== Searching for old 'quick_start' references ==="
rg -n 'quick_start' --type md --type ts --type js --type json 2>/dev/null || echo "No matches found"

echo ""
echo "=== Searching for old 'flashinfer_trace' path references ==="
rg -n 'flashinfer_trace' --type md --type ts --type js --type json 2>/dev/null || echo "No matches found"

echo ""
echo "=== Checking if new quickstart documentation file exists ==="
fd -t f 'quickstart' docs/ 2>/dev/null || echo "No matching files found"

echo ""
echo "=== Checking if new flashinfer-trace file exists ==="
fd -t f 'flashinfer-trace' docs/ 2>/dev/null || echo "No matching files found"

echo ""
echo "=== Listing docs directory structure ==="
fd -t f . docs/ | head -20

Length of output: 445

🏁 Script executed:

#!/bin/bash
# Description: Explore repository structure to locate documentation and verify paths.

echo "=== Repository root contents ==="
ls -la | head -20

echo ""
echo "=== Search for all mdx files ==="
find . -name "*.mdx" -type f 2>/dev/null | head -20

echo ""
echo "=== Search for index documentation file ==="
find . -name "index.*" -path "*/docs/*" -type f 2>/dev/null | head -20

echo ""
echo "=== Search for 'start' directory ==="
find . -type d -name "start" 2>/dev/null

echo ""
echo "=== Search for quickstart or quick-start references ==="
find . -name "*quickstart*" -o -name "*quick-start*" 2>/dev/null | head -20

echo ""
echo "=== Search for all documentation-related files ==="
find . -path "*/docs/*" -type f 2>/dev/null | head -30

Length of output: 2373

🏁 Script executed:

#!/bin/bash
# Description: Inspect the actual content of docs/index.mdx to verify the path changes.

echo "=== Content of docs/index.mdx around lines 20-30 ==="
cat -n docs/index.mdx | sed -n '15,30p'

echo ""
echo "=== Full content of docs/index.mdx ==="
cat docs/index.mdx

echo ""
echo "=== Verify actual files in docs/start/ ==="
ls -la docs/start/

echo ""
echo "=== Verify actual directories in docs/ ==="
ls -la docs/ | grep "^d"

Length of output: 2613

The updated paths reference non-existent files and directories, creating broken links.

The changes to docs/index.mdx update the paths to:

  • ./start/quickstart (line 23)
  • ./flashinfer-trace (line 25)

However, the actual files and directories still use the old names:

  • ./docs/start/quick_start.mdx (not quickstart)
  • ./docs/flashinfer_trace/ directory (not flashinfer-trace)

Either rename the files and directories to match the new paths, or revert the index.mdx changes to point to the existing paths.

🤖 Prompt for AI Agents 
In docs/index.mdx around line 23, the updated link "Get Started:
./start/quickstart" (and similar at line 25 for ./flashinfer-trace) points to
non-existent paths; restore or correct links to the actual files. Change the
links to the existing paths (./start/quick_start.mdx and ./flashinfer_trace/) or
alternatively rename the target files/directories to match the new slugs; update
only the index.mdx links if you prefer not to move files, ensuring relative
paths match the repository structure and verify the links resolve.

- Installation: ./start/installation
- Schema (FlashInfer Trace): ./flashinfer_trace/flashinfer_trace
- Schema (FlashInfer Trace): ./flashinfer-trace
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Verify the updated FlashInfer Trace schema path exists and is accessible.

The path was updated from ./flashinfer_trace/flashinfer_trace to ./flashinfer-trace. Confirm that the documentation file exists at the new path and that the link renders correctly.

Run the following script to check for any remaining references to the old path in the codebase:

🏁 Script executed:

#!/bin/bash
# Description: Search for references to the old "flashinfer_trace/flashinfer_trace" path.

# Search for old path pattern
rg -n 'flashinfer_trace/flashinfer_trace|flashinfer_trace' --type md --type mdx --type ts --type js --type json | head -20

Length of output: 27

I'll generate corrected scripts to verify the path update without the unrecognized file type:

🏁 Script executed:

#!/bin/bash
# Search for references to old flashinfer_trace path in markdown and code files
echo "=== Searching for old path references ==="
rg -n 'flashinfer_trace/flashinfer_trace' -g '*.md' -g '*.mdx' -g '*.ts' -g '*.js' -g '*.json'

echo ""
echo "=== Searching for standalone flashinfer_trace directory references ==="
rg -n 'flashinfer_trace' -g '*.md' -g '*.mdx' --no-heading -C 2 | head -30

echo ""
echo "=== Checking if new path exists ==="
fd -t d 'flashinfer-trace' || echo "No directory found with pattern flashinfer-trace"

echo ""
echo "=== Looking for new path reference in docs ==="
rg -n 'flashinfer-trace' -g '*.md' -g '*.mdx' -C 2

Length of output: 5020

🏁 Script executed:

#!/bin/bash
# Search for actual schema documentation files
echo "=== Looking for schema documentation files ==="
fd -e md -e mdx | grep -E '(schema|flashinfer)' 

echo ""
echo "=== Checking for flashinfer-trace directory or file ==="
fd 'flashinfer.*trace' -t f -t d

echo ""
echo "=== Listing docs directory structure ==="
find docs -type f -name '*.mdx' -o -name '*.md' | sort

Length of output: 1043

🏁 Script executed:

#!/bin/bash
# Verify the exact index content and path mismatch
echo "=== Current docs/index.mdx lines 23-27 ==="
sed -n '23,27p' docs/index.mdx

echo ""
echo "=== Verify actual directory exists with underscores ==="
ls -la docs/flashinfer_trace/ | head -10

echo ""
echo "=== Check if hyphenated directory exists ==="
ls -la docs/flashinfer-trace/ 2>&1 || echo "Directory does not exist (as expected)"

Length of output: 822

Update the path from ./flashinfer-trace to ./flashinfer_trace in docs/index.mdx line 25.

The updated path uses hyphens (./flashinfer-trace), but the actual directory in the repository uses underscores (docs/flashinfer_trace/). This breaks the documentation link. The directory exists at ./flashinfer_trace and contains the schema documentation files.

🤖 Prompt for AI Agents 
In docs/index.mdx around line 25, the link text uses the wrong path
'./flashinfer-trace' but the repository directory is './flashinfer_trace';
update the path to './flashinfer_trace' so the documentation link points to the
existing docs/flashinfer_trace/ directory.

- Tutorials: ./tutorials/bring_your_own_kernel
- API Reference: ./api/reference
Binary file removed examples/res/win_at_p_curve_gemm_o3_gpt-5.png
View file
Open in desktop
Binary file not shown.
Loading
Loading