Cur le doiciméadú Weblate

Tá fáilte romhat an leathanach doiciméadaithe de do rogha féin a fheabhsú. Déan é go héasca trí chliceáil ar an gcnaipe Cuir in eagar ar GitHub sa chúinne uachtarach ar dheis den leathanach.

Documentation guidelines

Tabhair meas ar na treoirlínte seo agus tú ag scríobh:

  1. Ná bain cuid den doiciméadú má tá sé bailí.

  2. Bain úsáid as teanga atá soiléir agus sothuigthe. Tá tú ag scríobh doiciméad teicneolaíochta, ní dán. Ní cainteoirí dúchais iad gach léitheoir doc, bí tuisceanach.

  3. Ná bíodh eagla ort fiafraí mura bhfuil tú cinnte. Má tá ort ceist a chur faoi ghné éigin agus tú ag déanamh eagarthóireachta, ná athraigh a dhoiciméid sula mbeidh an freagra agat. Ciallaíonn sé seo: Athraíonn tú nó iarrann tú. Ná déan an dá rud ag an am céanna.

  4. Fíoraigh do chuid athruithe trí ghníomhartha tuairiscithe a dhéanamh agus na doiciméid á leanúint.

  5. Seol PR le hathruithe i bpíosaí beaga chun é a dhéanamh níos éasca agus níos tapúla athbhreithniú agus cumasc a dhéanamh.

  6. Más mian leat struchtúr alt mór a athscríobh agus a athrú, déan é in dhá chéim:

    1. Athscríobh

    2. Nuair atá an athscríobh athbhreithnithe, snasta, agus cumaiscthe, athraigh struchtúr na míreanna i PR eile.

Building the documentation locally

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.

Translating the documentation

Is féidir leat na doiciméid a aistriú.

Documenting permissions, checks, add-ons and automatic suggestions

Several documentation sections use templates generated from the code. The following management commands are available:

All these commands output reStructuredText which is used as a template for the documentation. The easiest way to apply changes to the documentation is using visual diff in your editor.