Update_Docs_And_Readme_md - Githubissues

ynput / ayon-cpp-api

An API Wrapper for Ayon server written in cpp

1 stars 0 forks source link

Update_Docs_And_Readme_md #9

Closed Lypsolon closed 1 month ago

Lypsolon commented 2 months ago

Is there an existing issue for this?

[X] I have searched the existing issues.

Please describe the feature you have in mind and explain what the current shortcomings are?

A new documentation system using github pages has been implemented, but now is the time to write all the documentation for it.

[x] inline docs
[x] md docs

How would you imagine the implementation of the feature?

Write the docs let the rest be history

Are there any labels you wish to add?

[X] I have added the relevant labels to the enhancement request.

Describe alternatives you've considered:

No response

Additional context:

No response

Lypsolon commented 2 months ago

https://ynput.github.io/ayon-cpp-api/classAyonApi.html#a5048c989d0cda207fc56cbbae97c23df needs better description on what endpoint it uses and how.

Lypsolon commented 1 month ago

this is done with the last merge.