From b90841d1e181a0f7730a68d06a57465c7370ea31 Mon Sep 17 00:00:00 2001 From: egeakman Date: Thu, 9 Nov 2023 02:24:27 +0300 Subject: [PATCH] Add doc structure --- README.md | 4 ++++ bootstrapper/data/README.md | 9 +++++++++ 2 files changed, 13 insertions(+) diff --git a/README.md b/README.md index 675324f..70d74f2 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ This repository contains the scripts and data used to bootstrap a new translation of the Python documentation. +## Why python-docs-bootstrapper? + +... + ## Installation ```bash diff --git a/bootstrapper/data/README.md b/bootstrapper/data/README.md index 7328c5d..63c91ba 100644 --- a/bootstrapper/data/README.md +++ b/bootstrapper/data/README.md @@ -9,6 +9,15 @@ Hello! This is the repository of the {{translation.language}} translation of the - [Other Translations](https://github.com/orgs/python/repositories?q=python-docs) (see how other translations are doing it) - [Python Docs Discord Server](https://discord.com/invite/sMWqvzXvde) (especially the `#translations` channel) +**Tips for the maintainers:** + +... + +**The ultimate checklist to get you started:** + +... + + ## Documentation Contribution Agreement Python's documentation is maintained using a global network of volunteers. By posting this project on Transifex, Github, and other public places, and inviting you to participate, we are proposing an agreement that you will provide your improvements to Python's documentation or the translation of Python's documentation for the PSF's use under the CC0 license (available at https://creativecommons.org/publicdomain/zero/1.0/legalcode). In return, you may publicly claim credit for the portion of the translation you contributed and if your translation is accepted by the PSF, you may (but are not required to) submit a patch including an appropriate annotation in the Misc/ACKS or TRANSLATORS file. Although nothing in this Documentation Contribution Agreement obligates the PSF to incorporate your textual contribution, your participation in the Python community is welcomed and appreciated.