வலைபெயர்ப்பு ஆவணங்களுக்கு பங்களிக்கவும்¶
நீங்கள் விரும்பும் ஆவணப் பக்கத்தை மேம்படுத்த உங்களை வரவேற்கிறோம். பக்கத்தின் மேல் வலது மூலையில் உள்ள GitHub இல் திருத்து பொத்தானைக் சொடுக்கு செய்வதன் மூலம் எளிதாகச் செய்யவும்.
ஆவணப்படுத்தல் வழிகாட்டுதல்கள்¶
எழுதும் போது இந்த வழிகாட்டுதல்களை மதிக்கவும்:
ஆவணத்தின் ஒரு பகுதியை செல்லுபடியாகும் என்றால் அதை அகற்ற வேண்டாம்.
தெளிவான மற்றும் எளிதில் புரிந்துகொள்ளக்கூடிய மொழியைப் பயன்படுத்துங்கள். நீங்கள் தொழில்நுட்ப ஆவணங்களை எழுதுகிறீர்கள், ஒரு பா அல்ல. எல்லா டாக்ச் வாசகர்களும் சொந்த பேச்சாளர்கள் அல்ல, சிந்தனையுடன் இருங்கள்.
நீங்கள் உறுதியாக தெரியவில்லையா என்று கேட்க பயப்பட வேண்டாம். திருத்துதல் செய்யும் போது சில அம்சங்களைப் பற்றி நீங்கள் கேட்க வேண்டியிருந்தால், உங்களிடம் பதில் இருப்பதற்கு முன்பு அதன் ஆவணங்களை மாற்ற வேண்டாம். இதன் பொருள்: நீங்கள் மாறுகிறீர்கள் அல்லது கேட்கிறீர்கள். இரண்டையும் ஒரே நேரத்தில் செய்ய வேண்டாம்.
டாக்சைப் பின்பற்றும்போது விவரிக்கப்பட்ட செயல்களைச் செய்வதன் மூலம் உங்கள் மாற்றங்களைச் சரிபார்க்கவும்.
சிறிய துகள்களில் மாற்றங்களுடன் pr ஐ அனுப்பவும், அதை எளிதாகவும் விரைவாகவும் மதிப்பாய்வு செய்து ஒன்றிணைக்கவும்.
நீங்கள் ஒரு பெரிய கட்டுரையின் கட்டமைப்பை மீண்டும் எழுதவும் மாற்றவும் விரும்பினால், அதை இரண்டு படிகளில் செய்யுங்கள்:
மீண்டும் எழுதவும்
மீண்டும் எழுதப்பட்டதும், மெருகூட்டப்பட்டதும், ஒன்றிணைந்ததும், பத்திகளின் கட்டமைப்பை மற்றொரு pr இல் மாற்றவும்.
ஆவணங்களை உள்நாட்டில் உருவாக்குதல்¶
Documentation can be also edited and built locally, the Python requirements are
in the docs dependency group in pyproject.toml. If you already use
the full development environment, uv sync --all-extras --dev is enough. For
documentation work only, uv sync --group docs is sufficient.
The recommended local workflow is:
make -C docs update-docs
./ci/run-docs
The ci/run-docs wrapper builds the documentation with warnings treated as errors.
Hint
ஆவணத்தை உருவாக்க உங்களுக்கு graphviz நிறுவப்பட்டிருக்க வேண்டும்.
ஆவணங்களை மொழிபெயர்க்கிறது¶
நீங்கள் <https://hosted.weblate.org/projects/weblate/documentation/>`_ ஆவணத்தை மொழிபெயர்க்கலாம்.
Updating generated documentation snippets¶
Several documentation sections use templates generated from the code. The preferred way to refresh them is:
make -C docs update-docs
This target regenerates the snippets currently used by the documentation, including:
add-on events, built-in add-ons, and common add-on parameters
machine translation services
file format parameters and file format feature tables
permissions and built-in roles
checks and check flags
Keep manually maintained text in the parent documentation page rather than adding it to autogenerated snippets. For example, துணை நிரல்கள் includes three generated files for events, built-in add-ons, and common add-on parameters, while obsolete add-ons are maintained directly in the page.
If you need to regenerate only one part, the individual management commands are
documented in மேலாண்மை கட்டளைகள், and the exact commands used by
update-docs are listed in docs/Makefile.