Document current state of ilab config functionality

[khaledsulayman]

Co-authored by: Charlie Doern cdoern@redhat.com Co-authored by: Nathan Weinberg nweinber@redhat.com Signed-off-by: Khaled Sulayman ksulayma@redhat.com

[khaledsulayman]

@instructlab/cli-maintainers I can't seem to request reviews already. PTAL when you have the time

[nathan-weinberg]

I would maybe add a final section that highlights the future work scoped out in https://github.com/instructlab/instructlab/issues/2106

[leseb]

Thanks @khaledsulayman @cdoern @nathan-weinberg for this doc! Very useful to have this Definitely worth getting @leseb 's input on it

He did some work that makes it so that the field descriptions in the config class are used to populate the click command help text and the comments in the config.yaml which could also be mentioned in this doc to build some surrounding context

The feature work is in 0.19 and this doc 0.18 so we can't mention it :/

[khaledsulayman]

I would maybe add a final section that highlights the future work scoped out in instructlab/instructlab#2106

@nathan-weinberg that epic largely needs to be refined/rewritten when we have time for it. It might be better to just more generally state some of the problems that exist with the current flow. If we have those clearly stated we can then more easily scope out what needs to get done to get to the desired end state once we have cycles for it.

[danmcp]

@khaledsulayman Did you mean to add the co-authors to the commit itself?

[jaideepr97]

what do we need to get this dev doc merged? its been sitting for a while

[nathan-weinberg]

@khaledsulayman needs to address comments but generally I think it's good to go