Restore the standalone SuperNPUBench documentation site - #24
Merged
Conversation
The published manual outlived its source on main. Restore the programmer-facing manual under a docs-owned build boundary, regenerate current benchmark coverage, and make Pages validation reproducible from the repository. Constraint: GitHub Actions must remain under .github/workflows for discovery Constraint: Current main contains 19 translated DeepSeek modules from a pinned 37-module upstream inventory Rejected: Keep MkDocs configuration and generators at repository root | website ownership would remain split Confidence: high Scope-risk: moderate Directive: Keep website configuration, dependencies, generated data, and generators under docs/ Tested: strict MkDocs build and internal-link verification; intrinsic, benchmark, and migration catalog checks; ruff; shellcheck; 39 compile manifest syntax checks; representative make dry-runs; desktop/mobile browser validation Not-tested: target benchmark compilation and simulator execution; no local Linx toolchain was available
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/, with content, MkDocs configuration, pinned dependencies, generators, data, and verification scripts owned togethermain, including 113 public intrinsic entries, 83 active build variants, and the 19 translated DeepSeek modules currently presentValidation
./docs/build.shpython3 docs/scripts/sync_golden_manual.py --checkpython3 docs/scripts/verify_deepseek_migration.pypython3 docs/scripts/verify_pto_kernel_migration.pyruff check docs/scriptsshellcheck docs/build.sh docs/content/examples/check.shpython3 -m compileall -q docs/scripts.github/workflows/pages.ymlwith PyYAMLcompile.allmanifestsmake -nbenchmark buildsThe strict site verifier reports 113 public C++ entries, current DeepSeek translations, 83 benchmark builds, and clean internal links.
Deployment
The Pages workflow publishes
site/after this PR merges tomain. The existing public site remains unchanged until that deployment completes.Known limitation
Target benchmark compilation and simulator execution were not run because a local Linx toolchain was not available.