The repository holds a few documents outside docs/wiki/. This page names them and describes their role so that a reader knows what they are. None of them is a source of truth for the wiki. Each entry is historical, not verified against code; where they disagree with a wiki page, the wiki page, which cites the code, applies.
Scope and source¶
- Defined in: the repository root and the folder
docs/ui_ustalik_kitabi/. - Count: four entries, chosen as the documents a reader of the wiki is pointed to. Other files under
docs/are internal working records and are not listed.
Documents¶
| Document | Role | Status |
|---|---|---|
CHANGELOG.md |
Release notes. The file follows the Keep a Changelog format and has one section per version, from 0.1.0 to 0.1.37, plus an unreleased section (counted as 39 level-two headings). The release convention is described on CI pipeline and release. |
Historical, not verified against code |
README.md |
The repository's front page: a short architecture summary, a module table, requirements, installation, running, and licence sections. | Historical, not verified against code |
README_INSTALL.txt |
A step-by-step installation guide in Turkish for a Windows workstation, in four steps. The current procedure is on Windows installer and local development setup. | Historical, not verified against code |
docs/ui_ustalik_kitabi/ |
The interface design book, described below. | Historical, not verified against code |
The interface design book¶
The folder docs/ui_ustalik_kitabi/ holds a book on interface design craft, written in Turkish: an index file, 35 chapters in six parts, and one appendix on the project's own icon set (37 files, counted with ls). The chapters range from perception and cognition through typography, colour, layout, motion, feedback, design tokens, theming, accessibility, internationalisation, dense enterprise interfaces, complex forms, and data visualisation to quality as a process. Several browser suites name chapters of the book in their header comments, for example web-client/_e2e_ui_tokens.mjs:1 and web-client/_e2e_density.mjs:1. The book is guidance, not a description of the product; the web app as built is documented in the web app section.
Related pages¶
Verified against commit 92f8051 on 2026-11-13.