Feature request: "best current practices" page
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by reviewing the existing Ocean documentation to determine whether a similar page already exists and which current and older protocols it covers. Organize the page around user tasks, identify the recommended current approach for each, and clearly mark older alternatives; done means newcomers can distinguish current practices from historical ones.
Written by the indexing model from the issue text.
Description
As the Ocean toolkit grows, you'll likely have a problem that has affected us in the Rosetta community: documentation for older protocols persists, and it can be difficult for a new user to pick out the best current practices. A page organized by tasks that a user might want to perform, indicating the best current way to accomplish the task, followed by a list of older ways that are clearly marked as older, would be very useful. (Note that I have not exhaustively explored the Ocean documentation. It is possible that this already exists.)
- Dominant language
- Python
- Stars
- 49
- Forks
- 28
- PR merge metrics
- No merged PRs in 30d
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.
More from dwavesystems/docs
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
dwavesystems/docs#75 · 3 comments ·
-
dwavesystems/docs#73 · 1 assignee ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
dwavesystems/docs#71 ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 45/100
dwavesystems/docs#67 ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
dwavesystems/docs#55 ·
All issues in dwavesystems/docs
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
use-agent-os/agent-os#3314 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
BasedHardware/omi#15662 · 1 comment ·
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
AiursoftWeb/AnduinOS-2#19 ·