observablehq / observablehq/plot

Channel documentation with a section describing z

Open Beginner friendly
#1,533 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
HTML
Stars
5.4k
Forks
244
PR merge metrics
No merged PRs in 30d

Description

When the documentation is updated with a description of channels, it would be helpful to dedicate a page for z. I was not aware of a general convention the letter follows (unlike x and y) so I found it hard in the beginning, when working with the previous readme documentation, that z is mentioned (or used) so often, but hardly explained.

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 reviewing the current channel documentation and the previous README documentation to see how x and y are explained and where channel pages are organized. Add a dedicated explanation for z that covers its general convention and existing uses, then confirm the documentation clearly explains the references noted in the issue.

Written by the indexing model from the issue text.

Assessment

Domain
data-visualization, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.