search

ynput / ayon-documentation

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

Add the first drafts of addon development docs #211

Closed MustafaJafar closed 1 day ago

MustafaJafar commented 1 month ago

Changelog Description

The first drafts of addon development docs.

Some TODOs on my list:

It's also worth mentioning, that I can continue these TODOs in some follow up PRs.

[!NOTE] This PR may take longer than usual to review.

Additional info

These docs are the summary of many discussions and small experiments over the past year. For a while, these notes remained in my notebook. When I felt they were in a useful condition I thought of moving them here. and, sorry for pushing a big commit.

Testing notes:

Read through the docs and let me know what do you think.

MustafaJafar commented 4 weeks ago

line: 537 For more info about how to implement a host integration please fgo to Host implementation I think there is an f too much in this sentence.

Creating new hosts can be fhard but, I think that's was typo 😂

mkolar commented 2 days ago

@MustafaJafar this is approved a couple of time, while actually being in draft....how come?

MustafaJafar commented 2 days ago

@MustafaJafar this is approved a couple of time, while actually being in draft....how come?

@mkolar I'm still thinking of some additions like web actions. But, if you guys this PR is good as first draft. then lets merge and we can always improve it over time.

mkolar commented 1 day ago

I would merge and keep improving. If you think it's not complete, add a disclaimer on the top that it's still WIP, but I'de merge it

MustafaJafar commented 1 day ago

I would merge and keep improving. If you think it's not complete, add a disclaimer on the top that it's still WIP, but I'de merge it

Good idea. I've just discovered that such a disclaimer already exists 😄 Then let's merge.