Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation discoverability #2064

Merged
merged 3 commits into from
Feb 3, 2022
Merged

Improve documentation discoverability #2064

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
84a703d
Improve documentation discoverability
Feb 3, 2022
3a9f3e2
Fixed version typo
Feb 3, 2022
ca5f7e8
Add more links to already existing docs
Feb 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,4 @@ Animal Logic forum is [here](https://groups.google.com/forum/#!forum/al_usdmaya-
+ [Building](doc/build.md)
+ [Coding guidelines](doc/codingGuidelines.md)
+ [License](doc/LICENSE.md)
+ [MayaToHydra](doc/MayaToHydra.md)
+ [Common Plug-in Base Commands](lib/mayaUsd/commands/Readme.md)
+ [Getting Started with USD in Maya 2022](https://help.autodesk.com/view/MAYAUL/2022/ENU/?guid=GUID-36CFE2C3-766F-4B00-8464-E94F95E7AF4B)
+ [Plugins documentation](README_DOC.md)
13 changes: 13 additions & 0 deletions README_DOC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Plugin Documentation
+ [Getting Started with USD in Maya 2022](https://help.autodesk.com/view/MAYAUL/2022/ENU/?guid=GUID-36CFE2C3-766F-4B00-8464-E94F95E7AF4B)


## Core Modules
+ [Common Plug-in Base Commands](lib/mayaUsd/commands/Readme.md)
+ [Managing Translation Options](lib/mayaUsd/fileio/doc/Managing_export_options_via_JobContext_in_Python.md)
+ [SchemaAPI Translators](lib/mayaUsd/fileio/doc/SchemaAPI_Import_Export_in_Python.md)
+ [UFE Transform](lib/mayaUsd/ufe/UsdTransform3d.md)
+ [Undo/Redo Support](lib/mayaUsd/undo/README.md)
+ [MaterialX](doc/MaterialX.md)
+ [MaterialX Code Gen](lib/mayaUsd/render/MaterialXGenOgsXml/README.md)
+ [MayaToHydra](doc/MayaToHydra.md)
2 changes: 1 addition & 1 deletion doc/MaterialX.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Once the updated plugin is in use, the viewport will automatically select Materi

### Building a MaterialX-enabled USD compatible with MayaUSD

We currently use MaterialX 1.38.3 and USD 20.11. Combining these two together requires patching USD:
We currently use MaterialX 1.38.3 and USD 21.11. Combining these two together requires patching USD:

```
git checkout tags/v21.11
Expand Down