From 9c81c9933aa4533fef82bcaec3a6d7018a0d088f Mon Sep 17 00:00:00 2001 From: Maciej Olko Date: Wed, 19 Nov 2025 11:24:21 +0100 Subject: [PATCH 1/4] Add the README --- README.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..d749c3f50 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +This project generates a dashboard presenting the Python documentation translations projects. + +There are two entrypoints: +- `generate.py`: Generates dashboard HTML and JSON files. +- `generate_build_details.py`: Generates the build details HTML file and log files for each translation project. From cc0667679a1251c4cdac7ccc03c9797bcd58eb6b Mon Sep 17 00:00:00 2001 From: Maciej Olko Date: Wed, 19 Nov 2025 22:36:34 +0100 Subject: [PATCH 2/4] Add badges --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index d749c3f50..f178f87d8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +![website status](https://img.shields.io/website?url=https%3A%2F%2Ftranslations.python.org&logoColor=yellow&label=website%20status) +[![lint](https://github.com/python-docs-translations/dashboard/actions/workflows/lint.yml/badge.svg)](https://github.com/python-docs-translations/dashboard/actions/workflows/lint.yml) + This project generates a dashboard presenting the Python documentation translations projects. There are two entrypoints: From d029dc2a4d324b0c867c1ce0710f117c57446591 Mon Sep 17 00:00:00 2001 From: Maciej Olko Date: Sun, 30 Nov 2025 04:10:25 +0100 Subject: [PATCH 3/4] Update README to specify project URL Clarified the description of the project in the README. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f178f87d8..5b4e3260e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ![website status](https://img.shields.io/website?url=https%3A%2F%2Ftranslations.python.org&logoColor=yellow&label=website%20status) [![lint](https://github.com/python-docs-translations/dashboard/actions/workflows/lint.yml/badge.svg)](https://github.com/python-docs-translations/dashboard/actions/workflows/lint.yml) -This project generates a dashboard presenting the Python documentation translations projects. +This project generates a dashboard presenting the Python documentation translations projects available at translations.python.org. There are two entrypoints: - `generate.py`: Generates dashboard HTML and JSON files. From f154f9cab2c9f762273321bfdf229f9e2b48aee3 Mon Sep 17 00:00:00 2001 From: Maciej Olko Date: Sun, 30 Nov 2025 04:11:26 +0100 Subject: [PATCH 4/4] Add hyperlink to translations.python.org in README Updated README to include a hyperlink for translations.python.org. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5b4e3260e..4f543af7a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ![website status](https://img.shields.io/website?url=https%3A%2F%2Ftranslations.python.org&logoColor=yellow&label=website%20status) [![lint](https://github.com/python-docs-translations/dashboard/actions/workflows/lint.yml/badge.svg)](https://github.com/python-docs-translations/dashboard/actions/workflows/lint.yml) -This project generates a dashboard presenting the Python documentation translations projects available at translations.python.org. +This project generates a dashboard presenting the Python documentation translations projects available at [translations.python.org](https://translations.python.org). There are two entrypoints: - `generate.py`: Generates dashboard HTML and JSON files.