Update Org level read me

[joesepi]

I created an org README pulling together some info but that was a week ago and this needs to be fixed up before launch

[joesepi]

Have a temp file in community repo until we are able to go public.
https://github.com/open-labrador/community/blob/main/README-ORG.md

[joesepi]

It seems that @caradelia has done a lot of work on the community's README that is maybe best for the ORG README. We should discuss the plan for both READMEs

[ckadner]

@Tomcli had created the .github repo which we made private today:

A .github repo can be used to share content across all the repos like code-of-conduct, license, and an Org README as a "landing page" on the instruct-lab org:
https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile

I think we should develop all that shared content in the .github repo -- but in "private" for now so we don't accidentally pre-announce -- after OS launch we make it public.

FYI @bjhargrave

[bjhargrave]

I created https://github.com/instruct-lab/.github/pull/2 to start updating the .github repo.

[mikebrow]

recommend keeping the .github repo minimal vs splitting up community information across two repos...

[mikebrow]

some oss projects include a stub file or two from .github that link to the community/project repo

[bjhargrave]

I think it is minimal. It needs to hold the basic github organizational level readme (which can link to more detailing information in this repo.)

[jjasghar]

I don't think this'll work till the .github repo is public. That's probably why it's not being picked up: https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile#adding-a-public-organization-profile-readme

[lhawthorn]

That is correct.

[lhawthorn]

Note that the current proposed org level read me file is outdated. We should revisit using that text and/or consider simply providing a basic project description and linking to project FAQ.

For truly minimum viable product launch, I prefer basic description and link to project FAQ in one .github.repo as documented above from @ckadner

[lhawthorn]

Related issue #95

[lhawthorn]

Related issue #148

[lhawthorn]

Proposal: Make readme.md super short and simple.

Welcome to InstructLab! We an open source project community with the goal of enabling anyone to improve AI and LLMs using the LAB technique.

To get started in with our project, please visit the project FAQ.

Why do it this way? An excellent question!

Right now, we have documentation in many places and they are rapidly being updated, merged, etc. The best first point of entry for any new human is the project FAQ. This will allow them quickly find the most up to date user docs (rather than random docs floating around that may be outdated or in various stages of clean up), figure out how to talk to us outside of the issues queues (InstructLab Slack), etc.

And this keeps us in the habit of making sure our project FAQ is regularly updated and scrubbed, because if the FAQ remains the first port of call for humans new to the project, they will graciously let us know when it is out of date.

AFAIK, @russellb will be flipping the switch to live to make the InstructLab repo public, so I am tagging him in this issue.

[lhawthorn]

We had a much better suggestion for the intro text from @lehors in #44

Suggest this is the text we use for now:

Welcome to InstructLab! We are an open source project that enables collaborative development of large language models, with a novel technology supporting incremental evolution of a model based on contributions from the community.

To get started in with our project, please visit the project FAQ.

[jjasghar]

Continued to be ongoing, until we make the readmes universally smaller.