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.
This change attempts to slot the existing files under
docs/
into a hierarchy that is more suitable for subsequent additions and improvements.The core idea is to define a set of directories under
docs/
that more clearly indicate where particular kinds of documentation can be found (and should go, when writing new docs):compiler/
: docs related to the Slang compilercompiler/command-line/
: docs related toslangc
compiler/implementation/
: contributor-facing docs on parts of the compiler implementation.contributor/
: general contributor-facing docsgfx/
: docs aboutgfx
gfx/guide
: thegfx
user's guidegpu-feature/
: docs on specific GPU API features and how they are exposed and implemented.historical/
: docs that are no longer relevant, but might not be good to delete entirelylanguage/
: docs related to the Slang languagelanguage/guide/
: the Slang language user's guidelanguage/reference/
: the in-progress language referenceproposals/
: place for language/API/etc. proposals that should go through a more involved design/review processstdlib/
: docs about the types/functions/etc. exposed by the Slang standard librarytarget/
: docs pertaining to specific targets, and feature support across targetsOne obvious missing piece here is:
compiler/api/
: docs (guide and reference) for using the Slang compiler via its API