docs: add documentation skeleton#789
Open
voltjia wants to merge 1 commit into
Open
Conversation
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
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/README.md.README.mdto point users to the structured documentation entry points.Motivation
InfiniOps only had a README, CONTRIBUTING guide, and the ATen operator guide as documentation entry points. This PR creates the first structured documentation skeleton so follow-up documentation work can land page by page without expanding the README.
Closes #
Type of Change
feat- new feature / new operator / new platformfix- bug fixperf- performance improvement (no behavioral change)refactor- code restructuring without behavior changetest- adding or fixing tests onlydocs- documentation onlybuild/ci- build system or CI configurationchore- tooling, formatting, or other non-code changes!in the Conventional Commits prefix or aBREAKING CHANGE:footer)Platforms Affected
WITH_CPU)WITH_NVIDIA)WITH_ILUVATAR)WITH_METAX)WITH_CAMBRICON)WITH_MOORE)WITH_ASCEND)WITH_TORCH)Smoke Test Result
N/A - documentation-only change. No platform code, build logic, generated wrappers, or runtime behavior changed.
Test Results on Supported Platforms
Full `pytest` output (optional)
Benchmark / Performance Impact
N/A - documentation-only change.
Notes for Reviewers
This PR intentionally does not add Doxygen generation, GitHub Pages publishing, or consumer CMake examples. Those should land as separate follow-up PRs so each step remains reviewable.