# დოკუმენტაცია {#docs}

წყარო: [github.com/tuist/tuist/tree/main/server/priv/docs](https://github.com/tuist/tuist/tree/main/server/priv/docs)

## რისთვისაა განკუთვნილი {#what-it-is-for}

დოკუმენტაციის საიტი შეიცავს Tuist-ის პროდუქტისა და კონტრიბუტორების დოკუმენტაციას. ის არის Tuist სერვერის ნაწილი, Phoenix აპლიკაცია, რომელიც ასახავს Markdown გვერდებს `server/priv/docs/en` ქვეშ მისამართზე `/docs`.

## როგორ შევიტანოთ წვლილი {#how-to-contribute}

ჩაასწორეთ ინგლისური გვერდები `server/priv/docs/en` ქვეშ. თარგმანები ცალკე იმართება, ამიტომ ნუ შეცვლით სხვა ენის დირექტორიებს. გვერდითი პანელი განისაზღვრება `server/lib/tuist/docs_sidebar.ex`-ში; დაამატეთ ახალი გვერდები იქ, რათა მკითხველებმა იპოვონ ისინი.

როდესაც რამდენიმე გვერდი იზიარებს ერთსა და იმავე ტექსტს, მაგალითად, ერთსა და იმავე სექციას სხვადასხვა ბილდის სისტემებში, მოათავსეთ ის ფაილში, რომლის სახელი იწყება `_`-ით ამ გვერდების გვერდით და ჩართეთ ის `@snippet:` HTML კომენტარით, რომელიც მიუთითებს ფაილზე, როგორც ეს არასტაბილური ტესტების გვერდებზეა გაკეთებული. ფაილები, რომლებიც იწყება `_`-ით, არ გამოქვეყნდება როგორც დამოუკიდებელი გვერდები.

### ლოკალურად გამართვა {#set-up-locally}

გაუშვით სერვერი `server` დირექტორიიდან, მიჰყევით მის [გამართვის ინსტრუქციებს](https://github.com/tuist/tuist/blob/main/server/AGENTS.md):

```bash
cd server
mise install
mise run dev
```

შემდეგ გახსენით [http://localhost:8080/en/docs](http://localhost:8080/en/docs).

### გენერირებული შინაარსი {#generated-content}

CLI-ის ცნობარი გენერირდება უახლესი CLI ვერსიის ბრძანების სპეციფიკაციიდან, ამიტომ მისი ლოკალურად აგება არ არის საჭირო.

ProjectDescription API-ის ცნობარი ცალკეა განთავსებული როგორც DocC საიტი მისამართზე [projectdescription.tuist.dev](https://projectdescription.tuist.dev). მისი ლოკალურად აგებისთვის, გაუშვით `mise run docs:project-description` რეპოზიტორიის ძირიდან.
