<feed xmlns='http://www.w3.org/2005/Atom'>
<title>slang.git/docs/user-guide/a3-01-reference-capability-profiles.md, branch master</title>
<subtitle>Making it easier to work with shaders</subtitle>
<id>https://git.yummers.dev/slang.git/atom?h=master</id>
<link rel='self' href='https://git.yummers.dev/slang.git/atom?h=master'/>
<link rel='alternate' type='text/html' href='https://git.yummers.dev/slang.git/'/>
<updated>2025-04-11T22:34:07+00:00</updated>
<entry>
<title>Fix user-guide typos (#6789)</title>
<updated>2025-04-11T22:34:07+00:00</updated>
<author>
<name>Gangzheng Tong</name>
<email>gtong@nvidia.com</email>
</author>
<published>2025-04-11T22:34:07+00:00</published>
<link rel='alternate' type='text/html' href='https://git.yummers.dev/slang.git/commit/?id=8e6af6259bd1dd47d81c36f0562ff362ca5d42c3'/>
<id>urn:sha1:8e6af6259bd1dd47d81c36f0562ff362ca5d42c3</id>
<content type='text'>
* Fix user-guide typos

Use LLM to scan each of the markdown files to fix typos.
Try not to change anything but the typos in this CL.

* typo not caught by LLM

* add output of ./build_toc.ps1</content>
</entry>
<entry>
<title>Markdown emphasis corrections (#5588)</title>
<updated>2024-11-19T17:08:20+00:00</updated>
<author>
<name>Ellie Hermaszewska</name>
<email>ellieh@nvidia.com</email>
</author>
<published>2024-11-19T17:08:20+00:00</published>
<link rel='alternate' type='text/html' href='https://git.yummers.dev/slang.git/commit/?id=0bf6a668208c65c980648fbe74a8c0a7bf4ded77'/>
<id>urn:sha1:0bf6a668208c65c980648fbe74a8c0a7bf4ded77</id>
<content type='text'>
* Add markdown formatting to extras/formatting.sh

* Correct formatting in markdown

* Warn on unrecognized argument in formatting script

* Print all diffs in formatting script

* Correct markdown emph formatting

* Don't format markdown by default

---------

Co-authored-by: Yong He &lt;yonghe@outlook.com&gt;</content>
</entry>
<entry>
<title>Document All Capability Atoms and Profiles (#5008)</title>
<updated>2024-09-05T14:41:35+00:00</updated>
<author>
<name>ArielG-NV</name>
<email>159081215+ArielG-NV@users.noreply.github.com</email>
</author>
<published>2024-09-05T14:41:35+00:00</published>
<link rel='alternate' type='text/html' href='https://git.yummers.dev/slang.git/commit/?id=d4aeb18cb348104fa6b036393488df780902a353'/>
<id>urn:sha1:d4aeb18cb348104fa6b036393488df780902a353</id>
<content type='text'>
* Document All Capability Atoms and Profiles

Fixes: #4125

Unimplemented Considerations:
1. This PR does not add support to query all capability-atom's from a command-line option. It is understood that this might be desired, due to this, the logic to generate `docs\user-guide\a3-02-reference-capability-atoms.md` was made to be "command-line friendly" so minimal changes are needed to pipe our documentation into a command-line option if this change is to be added.

Changes:
1. Added a way to document atoms inside `.capdef`. Method to document is described under `source\slang\slang-capabilities.capdef`. The goal is to error if a public atom does not have any form of documentation to ensure we always have up-to-date documentation to guide user on what an atom is/does.
    * The following `.capdef` file syntax was added
        * /// [HEADER_GROUP]
        * /// regular comment
2. When capability generator runs it auto-generates `docs\user-guide\a3-02-reference-capability-atoms.md`
3. Added to the user-guide 3 sections: `Reference`, `Reference -&gt; Capability Profiles`, `Reference -&gt; Capability atoms` section</content>
</entry>
</feed>
