ynput / ayon-documentation

Documentation of Ayon
Creative Commons Attribution Share Alike 4.0 International
5 stars 13 forks source link

The first iteration of adding USD docs #205

Closed MustafaJafar closed 1 month ago

MustafaJafar commented 1 month ago

Changelog Description

Adding USD Docs.

Additional info

First drafts of the docs exists here AYON USD Workflow Guide

Testing notes:

  1. start with this step
  2. follow this step
MustafaJafar commented 1 month ago

How it looks like currently:

image image

MustafaJafar commented 1 month ago

Here's how badges added in this commit https://github.com/ynput/ayon-documentation/pull/205/commits/0b4e51fe2eef0ba2bdac893bf9a410c7efac9a10 look image

BigRoy commented 1 month ago

Ah, looking nice.

BigRoy commented 1 month ago

🕐 Deadline!

We're looking to get this into a solid basic state for USD documentation by this Friday to be able to merge it as a 'first pass' on USD documentation. It'd be good to go over it and review it as if this is all the usd knowledge one may have for AYON with USD. So please fill in where you see gaps that are crucial for a that 0.1 release of AYON USD docs.

MustafaJafar commented 1 month ago

I've added a feature card for USD image

BigRoy commented 1 month ago

Can we remove the experimental from those Supported Product Types? :)

MustafaJafar commented 1 month ago

experimental

Sure, here it's https://github.com/ynput/ayon-documentation/pull/205/commits/8e79f4f3626cd49832909b2a2573f8db66e533fc

image

LiborBatek commented 1 month ago

Even tho its already approved, I would like to add a few notes...

First, great work @BigRoy and @MustafaJafar ...it is much clearer for understanding (maybe because I have practised a bit with USD in maya too :)

It would be lovely to add a section to the Contribution Workflow how this works with usdAsset and usdShot and AYON folder context...as if Im not mistaken thats the root aka target prim to contribute too. At least thats what I think...simply the context from which you are about to make a contribution decides the target prim to contribute to e.g. character or shot 100. Its just small bit of info missing to me. So as the user stays in the proper context, the automatic contribution workflow will take care of the root prim and writes (contribute) to correct hierarchy...

It could be just short info plus hierarchy example (those "code block" styled ones) not anything long text wise.

Other than missing bits (shot workflow, animation, lookdev workflow in maya parts) looks good! Thanks again!

MustafaJafar commented 1 month ago

It would be lovely to add a section to the Contribution Workflow how this works with usdAsset and usdShot and AYON folder context...as if Im not mistaken thats the root aka target prim to contribute too. At least thats what I think...simply the context from which you are about to make a contribution decides the target prim to contribute to e.g. character or shot 100. Its just small bit of info missing to me. So as the user stays in the proper context, the automatic contribution workflow will take care of the root prim and writes (contribute) to correct hierarchy...

It could be just short info plus hierarchy example (those "code block" styled ones) not anything long text wise.

@LiborBatek I have added something similar which lives in FAQ section. http://localhost:3000/docs/addon_usd_artist_faq#what-are-all-these-publisher-options-like-target-product could you tell me if that what you are looking for ?

MustafaJafar commented 1 month ago

Well, it's not bad for a first iteration. let's merge it! And there's always room for improvements.