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.

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

Update AYON USD Docs and Add AYON USD Resolver Docs #238

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from
2 changes: 2 additions & 0 deletions website/docs/addon_usd_admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
id: addon_usd_admin
title: USD Admin Docs
sidebar_label: USD
description: AYON USD Addon documentations for admins.
toc_max_heading_level: 5
---

import ReactMarkdown from "react-markdown";
Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_usd_artist_contribution_workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
id: addon_usd_artist_contribution_workflow
title: AYON USD Contribution Workflow
sidebar_label: Contribution Workflow
description: Automatically contribute products into USD assets or shots
toc_max_heading_level: 5
---

Automatically contribute products into USD assets or shots

:::info

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should rather say that the Ayon contribution workflow was introduced around this time or its version, not this pr.

Reason:
many commits Created the Contribution workflow.
It might be confusing if you look at this one PR and don't see all the parts that made the contribution workflow.

The **AYON USD Contribution Workflow** was introduced with PR [Implement USD workflow with global asset/shot contributions plug-in](https://github.com/ynput/ayon-core/pull/295)
:::
Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_usd_artist_faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
id: addon_usd_artist_faq
title: FAQ
sidebar_label: FAQ
description: Frequently Asked Questions or Issues
toc_max_heading_level: 5
---

Frequently Asked Questions or Issues

### I do not see my model on loading the asset

<details><summary>On Load warning message "Unresolved Reference Path" shows</summary>
Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_usd_artist_get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
id: addon_usd_artist_get_started
title: Getting Started with USD in AYON
sidebar_label: Getting Started
description: A quick start into AYON x USD
toc_max_heading_level: 5
---

A quick start into AYON x USD

## Assets and Shots

Within the USD workflow we usually make a big distinction between **Assets** and **Shots**.
Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_usd_artist_houdini_workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
id: addon_usd_artist_houdini_workflow
title: Houdini USD Workflow
sidebar_label: Houdini Workflow
description: Getting started with AYON USD integration in SideFX Houdini
toc_max_heading_level: 5
---

Getting started with AYON USD integration in SideFX Houdini

import ReactMarkdown from "react-markdown";
import versions from '@site/docs/assets/json/Ayon_addons_version.json'

Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_usd_artist_maya_workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
id: addon_usd_artist_maya_workflow
title: Maya USD Workflow
sidebar_label: Maya Workflow
description: Getting started with AYON USD integration in Autodesk Maya
toc_max_heading_level: 5
---

Getting started with AYON USD integration in Autodesk Maya

import ReactMarkdown from "react-markdown";
import versions from '@site/docs/assets/json/Ayon_addons_version.json'

Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_usd_artist_usd_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
id: addon_usd_artist_usd_intro
title: Why and What is USD?
sidebar_label: USD Intro
description: Introduction to USD and reasons to adopt it
toc_max_heading_level: 5
---

Introduction to USD and reasons to adopt it

## Why USD
[USD Explainer Guide](https://www.foundry.com/insights/film-tv/usd-explainer-guide) article provides great insights about why USD is very useful.

Expand Down
19 changes: 19 additions & 0 deletions website/docs/addon_usd_resolver_admin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
id: addon_usd_resolver_admin
title: AYON USD Resolver
sidebar_label: USD Resolver
description: AYON USD Resolver documentations for admins.
toc_max_heading_level: 5
---

import ReactMarkdown from "react-markdown";
import versions from '@site/docs/assets/json/Ayon_addons_version.json'
MustafaJafar marked this conversation as resolved.
Show resolved Hide resolved

<ReactMarkdown>
{versions.USD_Badge}
</ReactMarkdown>

BigRoy marked this conversation as resolved.
Show resolved Hide resolved

:::info
This page is still under construction 👷🚧🛠️🔜🏗️.
:::
19 changes: 19 additions & 0 deletions website/docs/addon_usd_resolver_artist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
id: addon_usd_resolver_artist
title: AYON USD Resolver
sidebar_label: USD Resolver
description: AYON USD Resolver documentations for artists.
toc_max_heading_level: 5
---

import ReactMarkdown from "react-markdown";
import versions from '@site/docs/assets/json/Ayon_addons_version.json'

<ReactMarkdown>
{versions.USD_Badge}
</ReactMarkdown>


BigRoy marked this conversation as resolved.
Show resolved Hide resolved
:::info
This page is still under construction 👷🚧🛠️🔜🏗️.
:::
17 changes: 16 additions & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ module.exports = {
"addon_usd_artist_contribution_workflow",
"addon_usd_artist_maya_workflow",
"addon_usd_artist_houdini_workflow",
"addon_usd_resolver_artist",
"addon_usd_artist_faq",
],
},
Expand Down Expand Up @@ -176,7 +177,21 @@ module.exports = {
"addon_syncsketch_admin",
"addon_flow_admin",
"addon_aquarium_admin",
"addon_usd_admin",
{
type: "category",
label: "USD",
link: {
type: 'generated-index',
title: 'AYON USD',
description:
"Welcome to AYON USD Docs for Admins!",
keywords: ['usd'],
},
items: [
"addon_usd_admin",
"addon_usd_resolver_admin",
],
},

].sort(sorted),
},
Expand Down
Loading