Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add READMEs #950

Merged
merged 18 commits into from
Jul 31, 2022
Merged

add READMEs #950

merged 18 commits into from
Jul 31, 2022

Conversation

fetsorn
Copy link
Contributor

@fetsorn fetsorn commented Jun 23, 2022 •
edited
Loading

Basic READMEs, partially resolves #205. In the future a script should generate READMEs from code and these should be used as base for templates.

Basic

  • short descriptions
  • usage snippets
  • links to API

Optional

  • cli: steps to run workflows
  • client: programmatic workflows
  • client: configs
  • client: hot to setup envs
  • client: how to register interface implementations

@fetsorn fetsorn marked this pull request as ready for review June 27, 2022 21:53
@fetsorn fetsorn requested a review from cbrzn June 27, 2022 22:16
@dOrgJelli dOrgJelli changed the base branch from prealpha-dev to origin-dev July 6, 2022 09:03
cbrzn
cbrzn previously approved these changes Jul 18, 2022
View reviewed changes
@dOrgJelli dOrgJelli merged commit 1d3313a into origin-dev Jul 31, 2022
@dOrgJelli dOrgJelli deleted the 205-readmes branch April 10, 2023 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dOrgJelli dOrgJelli dOrgJelli approved these changes

@cbrzn cbrzn cbrzn left review comments

@namesty namesty Awaiting requested review from namesty namesty is a code owner

@krisbitney krisbitney Awaiting requested review from krisbitney

@nerfZael nerfZael Awaiting requested review from nerfZael

@ramilexe ramilexe Awaiting requested review from ramilexe

@Niraj-Kamdar Niraj-Kamdar Awaiting requested review from Niraj-Kamdar

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@fetsorn @dOrgJelli @cbrzn