Use example names instead of numbers so they are persistent

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

Nobody has claimed this yet.

Assessment

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

Research direction

Start by locating the AS2 core and vocab documents and reviewing how their examples are dynamically numbered. Give each example a persistent name that can be referenced across document versions, then verify that the example references remain stable after changes to document order.

Written by the indexing model from the issue text.

Description

Next version

The examples in AS2 core and vocab are dynamically numbered, and changes in the document change the numbering order. Adding a name to each example will give them a persistent identity that can be referred to across versions of the document.

h/t @TallTed for the good idea.

Dominant language
HTML
Stars
313
Forks
70
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from w3c/activitystreams

All issues in w3c/activitystreams

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.