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.

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

Add Getting Started Docs #265

Open
jag3773 opened this issue Apr 29, 2021 · 2 comments
Open

Add Getting Started Docs #265

jag3773 opened this issue Apr 29, 2021 · 2 comments
Labels
Documentation Things to include or change in the doc Talk About This! Consider putting this issue on the agenda for an SB meeting

Comments

@jag3773
Copy link
Collaborator

jag3773 commented Apr 29, 2021

I think it would be really helpful if we added a "Getting Started" or a "Quick Start Guide" to the docs. This would, of course, be aimed at developers and would have the goal of getting a developer running in 15 minutes or less.

@jag3773 jag3773 added Documentation Things to include or change in the doc Talk About This! Consider putting this issue on the agenda for an SB meeting labels Apr 29, 2021
@jtauber
Copy link
Collaborator

jtauber commented May 6, 2021

When you say "getting a developer running" do you mean how to create burritos? or how to consume them? or something else?

@jag3773
Copy link
Collaborator Author

jag3773 commented May 7, 2021

I think we would need both, but initially it would just be pointers to libraries and snippets of code for easier on ramps. For example, this project https://github.com/bible-technology/scripture-burrito-rcl gives you a React form for reading or editing SB metadata out of the box. Maybe this should be structured by target language, e.g.:

  • Using SB with JS
  • Using SB with Python
  • etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Things to include or change in the doc Talk About This! Consider putting this issue on the agenda for an SB meeting
Projects
None yet
Development

No branches or pull requests

2 participants