Îmbunătățiți acest manual¶
Manualul este scris în format Markdown în directorul docs/ și generat cu MkDocs.
Previzualizare locală¶
Creați un mediu virtual și instalați dependențele de documentație:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Deschideți adresa locală tipărită de MkDocs. Previzualizarea se reconstruiește când se modifică un fișier sursă.
Validați site-ul¶
Înainte de a deschide o cerere de tragere:
Compilarea strictă raportează intrări de navigare lipsă, linkuri nevalide detectate de MkDocs și avertismente de configurare.
Principii de scriere¶
- Scrieți pentru o anumită sarcină și public.
- Indicați versiunea MRBS atunci când comportamentul este specific versiunii.
- Preferați exemplele testate în detrimentul listelor exhaustive.
- Nu includeți niciodată acreditări reale sau date private de rezervare.
- Conectați sarcinile asociate în loc să duplicați secțiuni mari.
- Actualizați toate traducerile disponibile atunci când este posibil.
Traduceri¶
Engleza este textul de referință. Paginile germană, franceză și spaniolă folosesc aceeași cale relativă cu un sufix local:
Când lipsește o traducere, site-ul revine la limba engleză. O traducere ar trebui să păstreze codul, setarea numelor, avertismentele și legăturile, folosind terminologia naturală în limba țintă.
Domeniul de aplicare¶
Acest arbore de documentație vizează MRBS 1.12.2. Modificările care descriu o ediție ulterioară trebuie să actualizeze domeniul de aplicare al versiunii vizibile sau să fie dezvoltate în setul de documentație pentru acea ediție.