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

The first iteration of adding USD docs #205

Merged
merged 71 commits into from
Aug 5, 2024
Merged

The first iteration of adding USD docs #205

merged 71 commits into from
Aug 5, 2024

Conversation

MustafaJafar
Copy link
Contributor

@MustafaJafar MustafaJafar commented Jul 26, 2024

Changelog Description

Adding USD Docs.

  • Create a feature card for USD addon
  • Add Artist Docs
    • USD Intro
    • Get Started
    • Contribution Workflow
    • Maya Workflow
    • Houdini Workflow
    • Blender Workflow ? (No clients asked for it as far as I know)
    • FAQ
  • Add Admin Docs
  • Give the Docs a last review

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 MustafaJafar marked this pull request as draft July 26, 2024 09:49
@MustafaJafar
Copy link
Contributor Author

How it looks like currently:

image
image

@MustafaJafar
Copy link
Contributor Author

Here's how badges added in this commit 0b4e51f look
image

@BigRoy
Copy link
Contributor

BigRoy commented Jul 26, 2024

Ah, looking nice.

@BigRoy
Copy link
Contributor

BigRoy commented Jul 31, 2024

🕐 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.

@BigRoy BigRoy marked this pull request as ready for review August 2, 2024 20:17
Copy link
Contributor

@BigRoy BigRoy left a comment

Choose a reason for hiding this comment

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

@MustafaJafar and @LiborBatek thanks for the help 🥳 💪

Massive work for a first iteration. There are still miles to go to make the docs better and more detailed, but there's also still a lot down to improving the tools themselves too.

This is a great starter guide for some edge cases that may arise and things to watch out for. Far from perfect but gets the Approved stamp from me for a first iteration. 🚀 ✅

Do another proof-read @MustafaJafar and feel free to merge.

@LiborBatek
Copy link
Member

LiborBatek commented Aug 5, 2024

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!

Copy link
Member

@LiborBatek LiborBatek left a comment

Choose a reason for hiding this comment

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

LGTM!

@MustafaJafar
Copy link
Contributor Author

MustafaJafar commented Aug 5, 2024

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
Copy link
Contributor Author

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

@MustafaJafar MustafaJafar merged commit 0df198f into main Aug 5, 2024
@MustafaJafar MustafaJafar deleted the Add-USD-Docs branch August 5, 2024 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants