Editable Documentation

Open
#40 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale

Research direction

Start by reviewing the repository's existing PDF documentation and how it is organized. Done would mean documenting a feasible editable format and a contribution path that supports translations, with the resulting documentation available in the repository.

Written by the indexing model from the issue text.

Description

Is it possible to change the documentation on the repository to an editable format instead of PDFs? That way it would be easier to contribute to it and even work in translations for it.

I'm from a non-english speaking country and would be great to be able to point people I'm teaching to this repository and that they are able to find documentation in their own language.

Dominant language
C#
Stars
974
Forks
161
PR merge metrics
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 Unity-Technologies/UnityPlayground

All issues in Unity-Technologies/UnityPlayground

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.