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

Create first-draft onboarding documentation #15

Open
Ilia-Kosenkov opened this issue Jul 1, 2023 · 1 comment
Open

Create first-draft onboarding documentation #15

Ilia-Kosenkov opened this issue Jul 1, 2023 · 1 comment

Comments

@Ilia-Kosenkov
Copy link

Hey @ScottArbeit, I saw your talk on NDC, and decided to check out your project myself. However, I find it really difficult to navigate the repo because of the lacking technical documentation. Could you please point me to a place where I can find information on how to get started with everything.
I suspect that the server can be hosted in docker and Grace CLI is a dotnet cli tool, but it is hard for me to connect these things together.

It is also possible that I am just blind and missed all of the documentation somewhere :)

@ScottArbeit
Copy link
Owner

@Ilia-Kosenkov Totally agree. So far this has just been a personal project and while I've been slowly cleaning some stuff up, I haven't done the kind of documentation you're looking for.

So... first of all, thank you so much for being interested.

Please give me a few days to write something up and test the process on a blank VM. I'll ping this issue when there's something there.

I'd be enormously grateful for your feedback once it's there. Sorry you might be the first to try it. Early days, but I really want the process of contributing to Grace to be a good experience. Gonna take some work to get it there, but I / we will.

@ScottArbeit ScottArbeit changed the title Missing documentation/diificult onboarding Create first-draft onboarding documentation Jul 1, 2023
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

2 participants