ossia / ossia/score-docs

Document the protocols

Open
#17 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
SCSS
Stars
3
Forks
16
Avg merge
1h 7m
Merged PRs (30d)
1

Description

There should be explanation pages on the website that explain how each protocol should be used in i-score.

  • OSC
  • Minuit
  • MIDI
  • HTTP
  • WebSockets
  • Serial port
  • OSCQuery

Contributor guide

Open the contributing guide

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

Start by inspecting the website documentation structure and the existing OSC, MIDI, and OSCQuery pages. Add explanation pages for the unchecked Minuit, HTTP, WebSockets, and Serial port protocols, with each page describing how the protocol is used in i-score; the checklist is done when all listed protocols are covered.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, networking
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.