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

Update docs with starter kit #634

Merged
merged 3 commits into from
Jul 19, 2024
Merged

Update docs with starter kit #634

merged 3 commits into from
Jul 19, 2024

Conversation

wwwillchen
Copy link
Collaborator

@wwwillchen wwwillchen commented Jul 18, 2024

@richard-to do you think there should be a standalone docs page for the starter kit?

@wwwillchen wwwillchen marked this pull request as ready for review July 18, 2024 23:33
@richard-to
Copy link
Collaborator

That's a good question. I'm not sure. I think for now starting with quickstart is fine. Can always adjust it later. But it does seem like the fastest way to get started, so I think it makes sense in quickstart.

But I guess maybe you're asking if the detailed explanation of the quick start should be in a separate document. In that case, I think yes. Because user does not necessarily need to know all the gritty details of how it works. The quick start should be just be boiled down to what you need to do get an app running. From there, the user could read more or they're experienced enough to get it by reading the code.

Personally, I'm a big fan of the Divio documentation system (https://docs.divio.com/documentation-system/) in terms of how they split up documentation. I see the quick start as a tutorial type documentation. Or maybe how-to.

And I think the explanation of the code is more in line with "explanation" documentation in the divio system.

@wwwillchen
Copy link
Collaborator Author

That's a good question. I'm not sure. I think for now starting with quickstart is fine. Can always adjust it later. But it does seem like the fastest way to get started, so I think it makes sense in quickstart.

But I guess maybe you're asking if the detailed explanation of the quick start should be in a separate document. In that case, I think yes. Because user does not necessarily need to know all the gritty details of how it works. The quick start should be just be boiled down to what you need to do get an app running. From there, the user could read more or they're experienced enough to get it by reading the code.

Personally, I'm a big fan of the Divio documentation system (https://docs.divio.com/documentation-system/) in terms of how they split up documentation. I see the quick start as a tutorial type documentation. Or maybe how-to.

And I think the explanation of the code is more in line with "explanation" documentation in the divio system.

thanks for the feedback. i split out the detailed explanation from the quick start into a "core concepts" page, which feels a lot better. I've also linked the different getting started pages with a "next" link to make it a bit more coheisve.

@wwwillchen wwwillchen merged commit 040885b into google:main Jul 19, 2024
3 checks passed
@wwwillchen wwwillchen deleted the cli_docs branch July 19, 2024 05:51
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