Skip to content

[Bounty: 15 coins] Provide alternative documentation expressed entirely in emoji #116

Description

@boomlinde

Summary

In order to provide more accessible documentation while minimizing the cost of translation, all the documentation in the project root (currently AGENTS.md, CLAUDE.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, LICENSE, MISSION-STATEMENT.md, README.md and SECURITY.md) should be translated to sequences of unicode emoji in a best effort to essentially represent the same thing. The emoji documentation can then be read by users that aren't proficient readers of English, and they can cross-reference the English language documentation only where necessary.

Despite the hefty set of requirements below, this should be a good first issue since it only concerns documentation on a level where in-depth knowledge of the implementation isn't necessary.

Requirements

  • This must not replace the original documentation in English.
  • The translated documentation should be placed inside a directory in the project root named "emoji", e.g. "emoji/README-.md" for the translation of the original "README.md".
  • The new files should retain the original formatting, including paragraphs, headings, lists, code blocks, tables and so on. It's only the text content that should be translated.
  • Precision, to the greatest extent possible, is of utmost importance. Ambiguity is however unavoidable in an English-to-emoji translation task like this. The users this feature is intended for may be more comfortable using emoji than English but are capable of cross-referencing the existing English-language documentation where the emoji would otherwise be ambiguous.

This in itself needs to be documented in a new file in the project root named "EMOJI.md". It should contain:

  • It should explain (in English) what the "emoji" directory is for and the reason the translations are provided.
  • The rationale for choice of emoji sequences to represent different words and terms. This should be presented as sections for each file, each containing a three-column table, the first column containing the emoji sequence, the second containing the English term, sentence or word, and the third containing a rationale for the choice in English.

Note that the "EMOJI.md" file must also have a corresponding translated "emoji/EMOJI.md" file. This file in itself needn't be documented in EMOJI.md due to the self-referential problems that would create.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions