buck2 icon indicating copy to clipboard operation
buck2 copied to clipboard
verified publisher icon facebook

buck2 Documentation

Open arlyon opened this issue 3 years ago • 3 comments

This is a general tracking issue patching holes in the buck2 documentation regarding background information, general use, rule writing, etc. Some high level goals:

  • [x] API docs for the prelude
    • providers
    • rules
  • [ ] buck2 for bazel users
  • [x] glossary
  • [x] quick start with and without the prelude
  • [ ] developer environment setup w/ extensions
  • [x] toolchains and toolchain rules

arlyon avatar Sep 21 '22 13:09 arlyon

API docs for the prelude and rules are already generated internally, we just need to repeat that process outside. I think the main step there is building/deploying a website.

Buck2 for bazel users would be very helpful.

We have a glossary - let me share it to you.

ndmitchell avatar Sep 21 '22 13:09 ndmitchell

buck2 for bazel users

While reading through the existing Buck2 docs I created a loose collection of things where Buck2 and Bazel differ that may be useful for this.

aherrmann avatar Sep 21 '22 14:09 aherrmann

I'd be good to have examples of projects and rules other than cpp's. I'm interested in Java in particular, but there could be others :D

pakoito avatar Apr 07 '23 02:04 pakoito