Skip to main content

Writing standard

GuildGate documentation must describe behavior that can be traced to source code, tests, or a published interface.

  • Keep public API names, error codes, and contract constants unchanged.
  • Separate the current stable release from historical migration examples.
  • State security boundaries precisely; do not turn a tested control into an absolute guarantee.
  • Keep English and Turkish pages technically equivalent.
  • Run code samples against published export paths and never include real credentials.
  • Release notes cover user-visible behavior, compatibility, migrations, and verified results only.
  • When a claim cannot be verified, narrow it or mark the remaining manual check.