Document mirroring rules
Open
Nobody has claimed this yet.
docs
- Dominant language
- JSON
- Stars
- 5.8k
- Forks
- 2.6k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 186
Description
What type of issue is this?
Other
What is the issue?
BCD supports a "mirror" support value that causes data to be intelligently mirrored from an upstream browser at build time, but this isn't documented yet.
What behavior were you expecting?
The mirroring should be documented, explaining how the mirroring works, and listing the rules that determine if and how data is mirrored.
What version(s) of BCD is the issue present in?
- The current BCD release
- The current version of the
mainbranch
Do you have anything more you want to share?
Action item from the BCD project meeting on 2024-11-19.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing BCD documentation and the build-time handling of the "mirror" support value. Document how mirroring works and list the rules that determine whether and how data is mirrored; the work is done when those rules are clear to users.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100