documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Orchid - Work in progress docs?

Open jbritain opened this issue 1 year ago • 3 comments

Obviously Orchid is still in beta, so it makes sense that the docs might not have made it to the site yet, but is there really no documentation for Orchid yet? An orchid branch for the repo with work in progress documentation would be handy to have, because a lot of the tools are nigh on impossible to use right now unless you've been involved in the development to some degree.

jbritain avatar Apr 11 '24 17:04 jbritain

@kbdharun

mirkobrombin avatar Apr 11 '24 21:04 mirkobrombin

Obviously Orchid is still in beta, so it makes sense that the docs might not have made it to the site yet, but is there really no documentation for Orchid yet? An orchid branch for the repo with work in progress documentation would be handy to have, because a lot of the tools are nigh on impossible to use right now unless you've been involved in the development to some degree.

The current default branch is the tracking branch for Orchid docs (Kinetic has a seperate branch, which has been archived). The man pages have been ported to Orchid, the remaining tasks are to port the core docs for the same. I will do it in the forthcoming days (have been busy with Uni work the past few weeks, so no new progress in docs).

I have a few drafts lying around for some new pages about the images we have, etc. Will focus on upstreaming and porting them.

kbdharun avatar Apr 11 '24 23:04 kbdharun

Alright, fair enough.

jbritain avatar Apr 12 '24 02:04 jbritain