Skip to main content

Documentation Scope

What belongs on the site​

  • product overview and user flows;
  • screen descriptions with states, navigation, data, and requests;
  • developer setup, local configuration, and CI/CD;
  • architecture pages for auth, networking, ranking, statistics, and analytics;
  • operational reference such as troubleshooting and update delivery.

What should not become standalone docs​

  • temporary TODO notes;
  • duplicated explanations of the same flow;
  • tiny one-off alerts without independent logic;
  • pixel-perfect values unless they are part of a design contract;
  • exhaustive method-level commentary for every helper.

Rule of thumb​

The site documents behavior, contracts, and architecture. Low-level implementation detail stays in code, types, tests, and short inline comments.