Skip to content

docs: fix hard errors from audit#40

Merged
factnn merged 1 commit into
mainfrom
fix/docs-hard-errors
Jun 17, 2026
Merged

docs: fix hard errors from audit#40
factnn merged 1 commit into
mainfrom
fix/docs-hard-errors

Conversation

@factnn

@factnn factnn commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

Fixed issues

# Severity File Issue
1 HIGH getting-started/index.md Stray \s in bash command
2 HIGH getting-started, datasets {term} MyST role inside bash code blocks
3 MEDIUM getting-started/index.md {term} MyST role inside inline code backticks
4 HIGH index.md:160-218 Entire toctree section duplicated (59 lines deleted)
5 HIGH 4 files Wrong import: kernelgenbench.runtime.get_device_typeruntime.get_device_type
7 HIGH getting-started, faq Python >= 3.8 → 3.10 (matches setup.py)
8 MEDIUM contributing.md MIT → Apache 2.0 License
9 MEDIUM extending.md runner.py → run.py

Fixed issues:
- Stray '\s' character in bash command (getting-started/index.md:90)
- {term} MyST role inside bash code blocks (getting-started, datasets)
- {term} MyST role inside inline code backticks (Datasets table)
- Duplicated toctrees causing sidebar duplication (index.md:160-218)
- Wrong import: kernelgenbench.runtime.get_device_type → runtime.get_device_type (4 files)
- Python version: 3.8+ → 3.10+ to match setup.py
- License: MIT → Apache 2.0 in contributing.md
- runner.py → run.py in extending.md

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@factnn factnn merged commit 7c7fccd into main Jun 17, 2026
1 check passed
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.

1 participant