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

Add AYON APIs & Resources section #239

Merged
merged 20 commits into from
Oct 1, 2024
Merged

Conversation

MustafaJafar
Copy link
Contributor

@MustafaJafar MustafaJafar commented Sep 11, 2024

Changelog Description

This PR adds AYON APIs & Resources to Docs.
It adds two things:

  • Add Dev resources drop down menu in the navigation bar.
  • Add APIs & Resources section in dev docs. where we can explain what is a particular API is used for and how to use it.

image

TODOs

Write a brief description about each item in this list, as well as add some examples:

  • REST API Docs
  • GraphQL API Docs
  • Python API Docs
  • C++ API Docs
  • USD Resolver API Docs
  • Frontend React Components

@MustafaJafar MustafaJafar added the type: enhancement New feature or request label Sep 11, 2024
@MustafaJafar MustafaJafar self-assigned this Sep 11, 2024
@MustafaJafar MustafaJafar marked this pull request as draft September 11, 2024 14:50
@MustafaJafar
Copy link
Contributor Author

This PR is created as Draft as it's a suggestion, and it's still up to the discussion to make a decision whether or not to continue working on this PR.

@mkolar
Copy link
Member

mkolar commented Sep 11, 2024

I really like it, however APIs and components might be a bit too specific. How about calling it Dev resources?

@MustafaJafar
Copy link
Contributor Author

I really like it, however APIs and components might be a bit too specific. How about calling it Dev resources?

I like Dev resources more.
I changed it in the navbar.
image

website/sidebars.js Outdated Show resolved Hide resolved
website/sidebars.js Outdated Show resolved Hide resolved
website/sidebars.js Outdated Show resolved Hide resolved
Co-authored-by: Milan Kolar <mkolar@users.noreply.github.com>
@MustafaJafar
Copy link
Contributor Author

Then, the next step begins. Let's finish these TODOs 🛠️

@MustafaJafar MustafaJafar linked an issue Sep 16, 2024 that may be closed by this pull request
2 tasks
@MustafaJafar MustafaJafar changed the title Add AYON APIs & Components section Add AYON APIs & Resources section Sep 18, 2024
@MustafaJafar MustafaJafar linked an issue Sep 18, 2024 that may be closed by this pull request
2 tasks

### Include it in your cmake projects

Once you include it and build your cpp project you'll no longer need the library.
Copy link
Member

Choose a reason for hiding this comment

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

This sounds like C++ tutorial.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe I should change the tone?

I just wanted to add an example without the intention to make it a C++ tutorial.
But, cmake and all these steps made it looks like a tutorial.

@MustafaJafar MustafaJafar marked this pull request as ready for review September 20, 2024 18:03
@Lypsolon
Copy link

for repos with submodules, you should clone via git clone --recurse-submodules <URL>

@MustafaJafar MustafaJafar requested a review from mkolar September 23, 2024 10:36
@Innders Innders removed their request for review September 23, 2024 14:25
@mkolar
Copy link
Member

mkolar commented Oct 1, 2024

@MustafaJafar how is this looking?

@MustafaJafar
Copy link
Contributor Author

@MustafaJafar how is this looking?

It looks good on my side and all examples were tested.

@MustafaJafar MustafaJafar merged commit d3c3168 into main Oct 1, 2024
@MustafaJafar MustafaJafar deleted the Add-AYON-APIs-&-Components branch October 1, 2024 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add AYON APIs section in developer documentation Embedded API Reference content from ayon-python-api
4 participants