summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2021-04-29Update nav.htmlYong He
2021-04-29Update document subtitle color (#1828)Yong He
2021-04-29Add gfx user's guide. (#1824)Yong He
* Add gfx user's guide. * Add getting started chapter in gfx-guide * Fixes * Fix * Polishing doc template
2021-04-26Matrix docs update (#1815)jsmall-nvidia
* #include an absolute path didn't work - because paths were taken to always be relative. * Update matrix documentation. * Small fixes. * Some small fixes. * Fixes and improvements to matrix doc. * Small fixes. * Additional matrix doc layout clarification.
2021-04-26Fix user-guide layout bug (#1821)Yong He
2021-04-26Improve user guide layout for narrow viewports (#1820)Yong He
2021-04-24Remove table of contents from user guide landing page.Yong He
2021-04-24Always expand root level of table of contents (#1819)Yong He
2021-04-24Auto generate interactive table of contents for user-guide. (#1818)Yong He
2021-04-22Improve document table of content style (#1812)Yong He
2021-04-22Fix documentation (#1811)Yong He
2021-04-22Fix layout for user-guide (#1810)Yong He
2021-04-22Set theme jekyll-theme-slateYong He
2021-04-22Fix errors in matrix-layout documentation (#1809)Yong He
* Fix errors in matrix-layout documentation * Fixup
2021-04-22Update a1-01-matrix-layout.mdYong He
2021-04-22Update a1-01-matrix-layout.mdYong He
2021-04-22Add doc on matrix layout (#1807)Yong He
* Add doc on matrix layout * Fixup
2021-04-16Add Hello world example. (#1797)Yong He
2021-04-14NVTRC 64 bit requirement (#1792)jsmall-nvidia
* #include an absolute path didn't work - because paths were taken to always be relative. * Made 64 bit requirement clearer for CUDA/PTX. Added compile assert for NVRTC for 32 bit OS, that are known to require 64bit. * Disabled location of NVRTC on linux/win x86. * Only restrict NVRTC on windows * Simplify checking on 64 bit windows for NVRTC. Co-authored-by: Tim Foley <tfoleyNV@users.noreply.github.com>
2021-03-30Update 04-interfaces-generics.mdYong He
2021-03-30Override NOTE font size (#1773)Yong He
2021-03-30Rename README.md to index.mdYong He
2021-03-30Move user-guide table of contents to _includes dir (#1771)Yong He
2021-03-30Add layout front matter specifier for user-guide docs (#1770)Yong He
2021-03-30Update 01-get-started.mdYong He
2021-03-30Create toc.htmlYong He
2021-03-30Update 00-introduction.mdYong He
2021-03-30Update and rename documentation.html to user-guide.htmlYong He
2021-03-30Update documentation.htmlYong He
2021-03-30Update documentation.htmlYong He
2021-03-30Update documentation.htmlYong He
2021-03-30Update documentation.htmlYong He
2021-03-30Organize landing page (#1769)Tim Foley
The landing page (`README.md`) has been growing larger and less tidy over time as we try to cram more and more information into it. This change makes a few edits to try to make the landing page shorter and more to the point: * Streamline the opening lines and try to make them focus on the credibility of the system * Break off the list of major features into its own subsection and try to highlight the ones that our current users say they benefit from the most * Move a lot of the information about documentation, examples, Shader Playground, etc. into their own sub-pages to avoid clutter * Break out the list of dependencies in the `License` section to make sure we are being accurate With this change the landing page links to the User's Guide directly, so we probably need to get that rendering nicely ASAP.
2021-03-30Create documentation.htmlYong He
2021-03-30Update README.mdYong He
2021-03-30Update README.mdYong He
2021-03-30Update 00-introduction.mdYong He
2021-03-30Update 00-introduction.mdYong He
2021-03-30Update README.mdYong He
2021-03-15Preliminary docs on 'Doc System'. (#1755)jsmall-nvidia
* #include an absolute path didn't work - because paths were taken to always be relative. * First docs on 'doc system'. * Small improvements to doc system documentation. Co-authored-by: Tim Foley <tfoleyNV@users.noreply.github.com>
2021-03-15Improvements in Docs requirements/availability (#1751)jsmall-nvidia
* #include an absolute path didn't work - because paths were taken to always be relative. * Use capability system in docs. Simplify how requirements/availability is produced. * Small fixes in output of availablity. * Updated stdlib doc. * Small improvements. Co-authored-by: Tim Foley <tfoleyNV@users.noreply.github.com>
2021-03-11stdlib documentation (#1745)jsmall-nvidia
* #include an absolute path didn't work - because paths were taken to always be relative. * Split out AST 'printing'. * Replace listener with List<Section> * Section -> Part. * Kind -> Type Flags -> Kind for ASTPrinter::Part * Improve comments around ASTPrinter. * toString -> toText on Val derived types. toText appends to a StringBuilder. * Added toSlice free function. Added operator<< for Val derived types. Use << where appropriate in doing toText. * More work at mark down output. * Fill in sourceloc for enum case. Add more sophisticated location determination for EnumCase. Refactored documentation output into DocMarkdownWriter. * Improvements for sig output. * Split up slang-doc into extractor and writer. * WIP generic support for doc support. * Some refactoring to make DocExtractor have potential to be used without Decls. * Made doc extraction work without Decls. * Output generic parameters. * Add generic parameter extraction. * Added writing variables. * Add an interface test. * Fix toArray. * Support for extensions, and inheritance. * Disable the doc test. * Added flags to compileStdLib. * More work around handling generics in markdown output. * More improvements around associated type handling. * List method names only once. Output in/out/inout/const * Fix namespace printing. * WIP summarizing doc output. * Small fixes and improvements for doc output. * Output all stdlib in single doc file. * Remove compile flags from addBuiltinSource. * Find only unique signatures. First pass at trying to get requirements. * First pass at requirements for stdlib docs. * Remove __ function/methods * Added Target Availability * Add markup access. Make sections of stdlib hidden. * MarkdownAccess -> Visibility Add isVisible methods Use ASTPrinter to print decl name. * Add current stdlib doc output. * Disable doc test for now. * Fix clang issue. * Don't use bullets and numbering , just use numbering. * Put methods in source order. * Fix bad-operator-call.slang test that fails because it now outputs out parameters as such. * Refactor MarkDownWriter to separate 'extraction' from output. * Fix typo around @ lines. * Fix issue with extracting 'before' when preceeded by complex attributes/modifiers. * Fix handling of generics with the same name. * Work around for having overloading with generics - we don't want to output generic params as part of name. * Remove generic paramters from name. * Simplify handling of outputting overridable names.
2021-02-19Add a chapter on target platforms (#1720)Tim Foley
* Add a chapter on target platforms The primary goals of this chapter are: * Make users aware of just how many different ways of handling things there are across targets. If a user leaves this chapter thinking "how in the world can you abstract over all these differences?", then we have done our job, because they are primed to understand why layout and parameter binding are **necessarily** complicated. * Help users to understand/recall the relevant capabilities and restrictions of the platforms they care about most. If somebody only cares about D3D12 and Vulkan, I want them to leave with a detailed understanding of how those two differ so they can understand the *specifics* of where the layout and parameter-binding algorithms have to treat those targets differently. All of this could conceptually be just a background section in the layout and parameter-binding chapter, but putting it off in its own chapter avoids that one taking forever to actually get where it is going. * Typos
2021-02-17Fix typo in user guide.Yong He
2021-02-17Further documentation on Slang specific features (#1716)Yong He
Co-authored-by: Tim Foley <tfoleyNV@users.noreply.github.com>
2021-02-12Add associated type and generic value parameter doc section (#1706)Yong He
* Add associated type and generic value parameter doc section * Typos and corrections.
2021-02-12First part of interfaces and generics doc. (#1704)Yong He
Co-authored-by: Tim Foley <tfoleyNV@users.noreply.github.com>
2021-02-12Further documentation work (#1703)Tim Foley
* Move around the conventional/convenience features chapters * Add a first draft of a section on compilation using `slangc` and the COM-lite API Co-authored-by: Yong He <yonghe@outlook.com>
2021-02-11Add convenience features chapter in user-guide doc (#1699)Yong He
* Fix getting started doc * Add convenience features chapter in user-guide doc Co-authored-by: Tim Foley <tfoleyNV@users.noreply.github.com>
2021-02-09Add more to User's Guide (#1698)Tim Foley
This change adds a first draft of an Introduction chapter, along with a chapter about the "conventional" features of Slang (when compared to HLSL, GLSL, and C/C++).
generated by cgit v1.2.3 (git 2.39.1) at 2026-06-04 12:04:39 +0000