cloudflare / cloudflare/boringtun

add an example

Open
#9 4 comments 2 reactions 0 assignees View on GitHub
enhancement
Dominant language
Rust
Stars
7.2k
Forks
532
PR merge metrics
No merged PRs in 30d

Description

examples in rust are tested in tests (easy to maintain) and and are a good tool for supporting users. since we won't have full docs for release, i think we should offer 2-3 examples of using the libary. @vkrasnov - do you think this is something you could do today?

Contributor guide

Open the contributing guide

Research direction

Start by locating the Rust examples and the tests that exercise them, since the issue identifies those as the maintenance approach. Add 2–3 examples showing how to use the library, and verify that the examples are covered by the relevant tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.