வலைபெயர்ப்பு ஆவணங்களுக்கு பங்களிக்கவும்

You are welcome to improve the documentation page of your choice. Do it easily by clicking the Edit on GitHub button in the top-right corner of the page.

ஆவணப்படுத்தல் வழிகாட்டுதல்கள்

எழுதும் போது இந்த வழிகாட்டுதல்களை மதிக்கவும்:

  1. ஆவணத்தின் ஒரு பகுதியை செல்லுபடியாகும் என்றால் அதை அகற்ற வேண்டாம்.

  2. தெளிவான மற்றும் எளிதில் புரிந்துகொள்ளக்கூடிய மொழியைப் பயன்படுத்துங்கள். நீங்கள் தொழில்நுட்ப ஆவணங்களை எழுதுகிறீர்கள், ஒரு பா அல்ல. எல்லா டாக்ச் வாசகர்களும் சொந்த பேச்சாளர்கள் அல்ல, சிந்தனையுடன் இருங்கள்.

  3. நீங்கள் உறுதியாக தெரியவில்லையா என்று கேட்க பயப்பட வேண்டாம். திருத்துதல் செய்யும் போது சில அம்சங்களைப் பற்றி நீங்கள் கேட்க வேண்டியிருந்தால், உங்களிடம் பதில் இருப்பதற்கு முன்பு அதன் ஆவணங்களை மாற்ற வேண்டாம். இதன் பொருள்: நீங்கள் மாறுகிறீர்கள் அல்லது கேட்கிறீர்கள். இரண்டையும் ஒரே நேரத்தில் செய்ய வேண்டாம்.

  4. டாக்சைப் பின்பற்றும்போது விவரிக்கப்பட்ட செயல்களைச் செய்வதன் மூலம் உங்கள் மாற்றங்களைச் சரிபார்க்கவும்.

  5. சிறிய துகள்களில் மாற்றங்களுடன் pr ஐ அனுப்பவும், அதை எளிதாகவும் விரைவாகவும் மதிப்பாய்வு செய்து ஒன்றிணைக்கவும்.

  6. நீங்கள் ஒரு பெரிய கட்டுரையின் கட்டமைப்பை மீண்டும் எழுதவும் மாற்றவும் விரும்பினால், அதை இரண்டு படிகளில் செய்யுங்கள்:

    1. மீண்டும் எழுதவும்

    2. மீண்டும் எழுதப்பட்டதும், மெருகூட்டப்பட்டதும், ஒன்றிணைந்ததும், பத்திகளின் கட்டமைப்பை மற்றொரு pr இல் மாற்றவும்.

ஆவணங்களை உள்நாட்டில் உருவாக்குதல்

Documentation can be also edited and built locally, the Python requirements are in the docs dependency group in pyproject.toml. The build can be performed using ci/run-docs.

Hint

You will also need graphviz installed to build the documentation.

ஆவணங்களை மொழிபெயர்க்கிறது

You can translate the docs.

அனுமதிகள், காசோலைகள், துணை நிரல்கள் மற்றும் தானியங்கி பரிந்துரைகளை ஆவணப்படுத்துதல்

பல ஆவணப்படுத்தல் பிரிவுகள் குறியீட்டிலிருந்து உருவாக்கப்பட்ட வார்ப்புருக்களைப் பயன்படுத்துகின்றன. பின்வரும் மேலாண்மை கட்டளைகள் கிடைக்கின்றன:

இந்த கட்டளைகள் அனைத்தும் வெளியீட்டு மறுசீரமைப்பு டெக்ச்ட் ஆகும், இது ஆவணங்களுக்கான வார்ப்புருவாக பயன்படுத்தப்படுகிறது. ஆவணங்களில் மாற்றங்களைப் பயன்படுத்துவதற்கான எளிதான வழி உங்கள் எடிட்டரில் காட்சி வேறுபாட்டைப் பயன்படுத்துகிறது.