linkedin / linkedin/Burrow

Where is the documentation

Open
#386 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
4k
Forks
818
Avg merge
1h 14m
Merged PRs (30d)
1

Description

I've been working with Borrow for some weeks now. Getting it running was a challenge because the documentation is sparse at best. I'd like to know where to find certain information like:

- How does the windowing really work, and how do I control it? What is the sampling interval?
- Where is configuration explained in more detail than in the Wiki? Current docs list the
configuration parameters, but little is available in terms of working examples with
coherent explanations. Basically to get something going currently involves a lot of guesswork.
- In short, where is a real writeup explaining this thing at a level of detail where we can work
with it without a lot of guesswork?

Thanks,

Jack

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no source files or tests; start by reviewing the existing Wiki and configuration documentation. Document how windowing and sampling intervals work, expand configuration guidance with coherent working examples, and ensure users can operate Burrow without guesswork.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
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.