> For the complete documentation index, see [llms.txt](https://sonic-ai-works.gitbook.io/sonic-networks-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sonic-ai-works.gitbook.io/sonic-networks-docs/documentation/developers/frontend-and-design-system/style-guide-template.md).

# Documentation Style Guide

Developer-owned template for SONIC technical, product, API and protocol documentation.

**Version `1.0.0` · Developer-owned documentation standard**

Use this template for SONIC technical, product, API and protocol documentation. It defines writing/structure rules; it does not duplicate mutable economic, API or deployment data.

## Document identity

Every substantive page should make its ownership clear:

```
Title
Audience
Owner/domain
Status / maturity
Version or effective date
```

## Page title icons

Use restrained GitBook/Font Awesome title icons as semantic navigation aids. Prefer one icon per page/section; do not insert decorative emoji into every heading.

Recommended families:

```
Applications   grid / desktop / mobile / globe
Creators       users / person / microphone / robot
Developers     code / terminal / diagram / calculator
Tokenomics     coins / chart-column / percent / shield
Security       shield / lock / key
AI & Sound     wand / wave-square / music
```

## Source ownership before repetition

Before copying a value into another page, identify its source of truth.

```
Token allocation / fee policy → Tokenomics
HTTP operation/schema          → API Reference / OpenAPI
Program deployment             → release registry + chain verification
Product behavior               → Applications
Implementation                 → Developers
Narrative thesis               → Whitepaper
```

Prefer links and compact summaries over duplicating full tables/specifications.

## Lifecycle pattern

Document the durable flow including failure/recovery:

```
request
→ validate
→ idempotent operation
→ reserve / authorize
→ dispatch / submit
→ callback / observation
→ verify
→ settle / release
→ reconcile
```

## Atomic values

Precision-sensitive docs must state asset, atomic value/representation and decimals. **Lamports are SOL-only.** SPL/Token-2022 assets use token atomic/base units.

Do not use JavaScript floating-point examples as canonical accounting logic.

## API examples

Endpoint examples must be backed by canonical `/api/v1` OpenAPI or labeled illustrative. For mutations document authentication, tenant/resource ownership, idempotency, authorization, terminal states, errors, retries and financial effects.

## Desktop and mobile

Do not combine desktop and mobile composition rules into one vague responsive section when implementation differs materially. Use the dedicated **Desktop Web UI** and **Mobile UI · Expo & React Native** pages.

## Security & product truth

Never publish private keys, API secrets, provider secrets, recovery material, ZK witnesses or privileged internal diagnostics. Never convert mock/reference balances, activity, rewards or configured addresses into Live claims.

## Release checklist

* technical owner reviewed behavior;
* links resolve to canonical authorities;
* no duplicated Tokenomics allocation/specification;
* amount units/decimals are explicit;
* retries/idempotency are documented where relevant;
* configured vs verified vs Live is explicit;
* desktop/mobile responsibility is correctly separated;
* accessibility and reduced-motion requirements are covered;
* API behavior changes have changelog/release evidence.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://sonic-ai-works.gitbook.io/sonic-networks-docs/documentation/developers/frontend-and-design-system/style-guide-template.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.