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

What about inline getting started doc into the README file? #316

Closed
tisonkun opened this issue Apr 10, 2023 · 3 comments
Closed

What about inline getting started doc into the README file? #316

tisonkun opened this issue Apr 10, 2023 · 3 comments

Comments

@tisonkun
Copy link
Contributor

It's a common path to understanding how to build and how play with a simple app.

Currently, we have the doc that located at https://github.com/streamnative/oxia/blob/main/docs/getting-started.md. This is fine but not quite straight forward. I propose and volunteer to merge it into the README file.

cc @merlimat @asafm thoughts?

@asafm
Copy link

asafm commented Apr 16, 2023

I personally like the lean approach. The only thing I would consider IMO to add to the landing page is the motivation for developing it.

@mattisonchao
Copy link
Member

Moving it to discussion. :) #444

@asafm
Copy link

asafm commented Mar 26, 2024

@mattisonchao
image
for next time

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

No branches or pull requests

3 participants