bazel-contrib / bazel-contrib/bazel-docs

Feature: Add examples as Tutorials or How-To Guides

Open
#12 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
MDX
Stars
7
Forks
12
Avg merge
20h 49m
Merged PRs (30d)
31

Description

Bazel examples live in a few places, such as

- https://github.com/aspect-build/bazel-examples
- https://github.com/bazelbuild/examples/
- https://awesomebazel.com/#demos
- Lots of smaller one-offs

We should make it easy for anyone to send us a trivial PR, to a .json file or something, to add their examples to the docsite.

The index of examples should be easy enough to search and browse, so that even after we've accumulated hundreds of them, users are still able to find one that is similar to their use case (if it exists)

Contributor guide

Open the contributing guide

Research direction

No implementation files or tests are named. Start by inspecting the existing docsite structure and the example sources at aspect-build/bazel-examples, bazelbuild/examples, and awesomebazel.com/#demos. Done should include a contribution path for trivial example submissions and an index that remains searchable and browsable as examples grow.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.