Skip to content

Conversation

@cdharris
Copy link

@cdharris cdharris commented Aug 10, 2022

@blahah & @NiklasTR does this direction look good to continue? is it roughly at the level of detail and complexity as you'd expect as an initial introduction to the openlab tool?

Mostly focused for now on helping curious providers, researchers, and other savvy interested biocomputational adjacent folks in the right direction.

It's missing a focus on developer onboarding for now, but this languaging depends on the contribution strategy overall that is currently being worked out (platforms / programmes, core team, contributors, etc) - we'll get to that soon.

Any feedback before I proceed with another round of edits and additions?

@cdharris cdharris changed the title Docs:Readme: First draft of high level intro. Docs: Improve the README for first onlookers of the openlab-cli Aug 10, 2022
@NiklasTR
Copy link
Contributor

thank you for getting started on a README!
A couple thoughts from my side:

  • I think @blahah has been thinking of a workflow to generate automated (partial) docs - it would be good to see how written word fit in best here on the README.md level
  • Perhaps it is wise to spend 80% of the README on the user and only 20% on the provider?
  • I think with the updated understanding of the project at this point we probably have to do another pass over the text. I am generally not a fan of superlatives / extra adjectives
  • We also have docs.labdao.xyz - I think it would be a good home for more extensive public documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants