How to use these docs
These docs are written for the people who install, engineer and run a YTCC system. This page explains how they are organised so that you can find what you need quickly.
Where to start
| You want to | Start with |
|---|---|
| Install YTCC on a server | Requirements, then the rest of Installation |
| Build your first project | Open the interface and choose the language and Create your first project |
| Understand how YTCC works | How YTCC works and the other Concepts pages |
| Design screens | A tour of the screen editor |
| Set up users and permissions | Permission model |
| Run and maintain the system | System administration, starting with Manage the YTCC processes |
| Look up a code or a port | Reference and Ports |
| Solve a problem | Troubleshooting |
Kinds of pages
Every page is one of four kinds:
- Tutorial: a guided first exercise, for example creating your first project. Follow it from top to bottom.
- How-to: the steps for one task. It starts with Before you begin, lists the Steps and ends with Result.
- Concept: explains how something works and why, for example the quality of a value. It has no steps.
- Reference: tables to look things up in, for example quality and command codes.
A how-to or tutorial page links to the concept it relies on instead of explaining it again.
Steps, screenshots and videos
Each step has a screenshot. Under it, Play video plays a short video of the step; Back to screenshot returns to the picture. The screenshots and videos show the English interface; the Turkish pages use the same pictures.
Every step heading has a fixed link. Point at the heading and click # next to it to get a link to that step, for example to send a colleague straight to step 3. The link stays the same in both languages.
Names in bold are the names on the screen, written exactly as they appear in the English interface. Keys are shown like Ctrl+S.
Language, search and llms.txt
The top bar holds:
- the language selector, English or Türkçe. It switches to the same page in the other language.
- the search box, which searches the pages of the current language.
- llms.txt, a plain-text list of all pages for AI assistants and other tools that read documentation.
The language of the docs is independent of the language of the YTCC interface; see Open the interface and choose the language.