feat: add documentation for scripts

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
This commit is contained in:
K.B.Dharun Krishna
2023-12-21 19:47:18 +05:30
parent ab46f0494f
commit b2dc1a28d1
4 changed files with 108 additions and 10 deletions

32
scripts/README.md Normal file
View File

@@ -0,0 +1,32 @@
# Scripts
The current directory contains useful scripts used/to use with `tldr` pages.
## Summary
This section contains a summary of the scripts available in this directory. For more information about each script, please refer to the
header of each script.
- [pdf](pdf/README.md) directory contains the `render.py` and `build-pdf.sh` script and related resources to generate a PDF document of tldr-pages for a specific language or platform (or both).
- [build.sh](build.sh) script builds the ZIP archives of the `pages` directory.
- [build-index.sh] script builds the index of available pages.
- [check-pr.sh] script checks the pages syntax and performs various checks on the PR.
- [deploy.sh] script deploys the ZIP and PDF archives to the static website repository.
- [send-to-bot.py] is a Python script that send the build or tests output to tldr-bot.
- [set-alias-pages.py] is a Python script to generate or update alias pages.
- [set-more-info-link.py] is a Python script to generate or update more information links across pages.
- [test.sh] script runs some basic tests on every PR/commit to make sure that the pages are valid and that the code is formatted correctly.
- [wrong-filename.sh] script checks the consistency between the filenames and the page title.
## Compatibility
The below table shows the compatibility of user-executable scripts with different platforms.
| Script | Linux | macOS (`osx`) | Windows |
| ------ | ----- | ----- | ------- |
| [render.py](pdf/render.py) | ✅ | ✅ | ✅ |
| [build-pdf.sh](pdf/build-pdf.sh) | ✅ | ✅ | ❌ |
| [build.sh](build.sh) | ✅ | ✅ | ❌ |
| [set-alias-pages.py](set-alias-pages.py) | ✅ | ✅ | ✅ |
| [set-more-info-link.py](set-more-info-link.py) | ✅ | ✅ | ✅ |
| [wrong-filename.sh](wrong-filename.sh) | ✅ | ❌ | ❌ |