-
Notifications
You must be signed in to change notification settings - Fork 224
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
[Docs] Comprehensive Getting Started Documentation #703
Comments
I fully agree with all of those points, and would like to add that a structured approach like https://diataxis.fr/ might be helpful. I'm also willing to spend some time writing documentation, but I also need some guidance as I cannot document things which I do not understand well (see #666 and #667 for example). |
I cannot commit to writing documentation at this time, but always love reading it, and wish there were more. |
if you can't have documentation i think a comprehensive list of samples would be a good start to getting a grasp of everything. some aspects I've only managed to figure out through experimentation. I guess it would be nice not to have to go through the guess work and then looking at the documentation to verify if my intuition is correct. |
As an additional note, the post from FB about buck2 has a link at the end to a getting started guide at https://buck2.build/docs/getting_started/ which is just a 404. |
Closing as:
|
@Jearil not that I can modify a post from facebook, but in case anyone else sees this, the correct URL for that is https://buck2.build/docs/about/getting_started/ |
If you've never used Buck2 before, the path to productive is pretty steep. I think we could make the documentation a bit clearer for users who sit outside of the Meta Ecosystem.
The documentation, while very comprehensive, is somewhat overwhelming and confusing if you are unfamiliar with development practices around Monorepo, or lack context to the facebook way of doing things (tools, testing, release, etc).
It would be good if the documentation had a section (perhaps for a handful of languages) that takes you somebody through the lifecycle of zero to hero (no project, to something running with internal and external dependencies), and migration from local tooling (Cargo, Gradle, Poetry, etc) into Buck2.
It would be good to get a bit of a user narrative that takes you through things like:
I appreciate this isn't exclusive, and that many of these segments are answered individually - but I think reducing the friction to get a user to productive would go a long way for uptake, and is probably stuff I imagine exists in the internal meta repo.
I'm happy to have a go at putting together a bit of a skeleton of information on the side, but lack context on the happy path and would need significant input.
The text was updated successfully, but these errors were encountered: