w3c / w3c/mathml

Add examples to core concepts

Open
#537 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

intent
Dominant language
HTML
Stars
82
Forks
23
PR merge metrics
No merged PRs in 30d

Description

There are probably many things that need to be worked on in the Concepts and Properties lists. Adding notational examples to all of the entries is one of those things.

This issue was motivated by a discussion with someone on intents and seeing that just because there was an intent name, it isn't clear to non-MathML "natives" what notation(s) the concept refers to. A minority of entries have examples, so there is plenty of work to do to done.

Currently, the examples that exist are in the "comments" column. Perhaps there should be a separate "example notations" column?

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

Review the Concepts and Properties lists and inspect the existing examples in the comments column. Determine whether examples belong in a separate example notations column, then add notation examples across the entries; the work is done when the lists consistently show what notation each concept refers to.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.