Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
685 commits
Select commit Hold shift + click to select a range
4ecd52d
Update creating-a-new-contract-vid.mdx
CryptAm Dec 12, 2025
02b65de
Update new-keyword-exercise.mdx
CryptAm Dec 12, 2025
627d279
Update new-keyword-sbs.mdx
CryptAm Dec 12, 2025
269d679
Update account-abstraction-on-base-using-biconomy.mdx
CryptAm Dec 13, 2025
4e02c8d
Update account-abstraction-on-base-using-particle-network.mdx
CryptAm Dec 13, 2025
0d82b9f
Update account-abstraction-on-base-using-privy-and-the-base-paymaster…
CryptAm Dec 13, 2025
d74e823
Update gasless-transactions-with-paymaster.mdx
CryptAm Dec 13, 2025
143da3f
Update bridge-tokens-with-layerzero.mdx
CryptAm Dec 13, 2025
1973e94
Update send-messages-and-tokens-from-base-chainlink.mdx
CryptAm Dec 13, 2025
1486987
Update access-real-time-asset-data-pyth-price-feeds.mdx
CryptAm Dec 13, 2025
ce2ec7e
Update access-real-world-data-chainlink.mdx
CryptAm Dec 13, 2025
73bacfc
Update build-a-smart-wallet-funding-app.mdx
CryptAm Dec 13, 2025
b15251a
Update building-an-onchain-app.mdx
CryptAm Dec 13, 2025
5cd33d5
Update introduction-to-providers.mdx
CryptAm Dec 13, 2025
018db55
Update overview.mdx
CryptAm Dec 13, 2025
ea57cb7
Update viem.mdx
CryptAm Dec 13, 2025
c1a8e21
Update wallet-connectors.mdx
CryptAm Dec 13, 2025
b2e924a
Update web3.mdx
CryptAm Dec 13, 2025
6317f6a
Update configuring-useReadContract.mdx
CryptAm Dec 13, 2025
c87cb28
Update useAccount.mdx
CryptAm Dec 13, 2025
2a1428c
Update useReadContract.mdx
CryptAm Dec 13, 2025
6f9a8aa
Update useSimulateContract.mdx
CryptAm Dec 13, 2025
9050a3f
Update useWriteContract.mdx
CryptAm Dec 13, 2025
f109e36
Update useWriteContract.mdx
CryptAm Dec 13, 2025
3827727
Update deploy-with-fleek.mdx
CryptAm Dec 13, 2025
4df063e
Update building-onchain-ai.mdx
CryptAm Dec 13, 2025
dda1781
Update building-onchain-frontend-development.mdx
CryptAm Dec 13, 2025
8a9fcba
Update building-onchain-gas.mdx
CryptAm Dec 13, 2025
aeda866
Update building-onchain-identity.mdx
CryptAm Dec 13, 2025
93ec8be
Update building-onchain-nodes.mdx
CryptAm Dec 13, 2025
bdb6bc0
Update building-onchain-onramps.mdx
CryptAm Dec 13, 2025
e5d346e
Update building-onchain-social-networks.mdx
CryptAm Dec 13, 2025
afc0259
Update building-onchain-wallets.mdx
CryptAm Dec 13, 2025
db4db3e
Update continue-building-onchain.mdx
CryptAm Dec 13, 2025
ee8664b
Update core-concepts.mdx
CryptAm Dec 13, 2025
b221568
Update development-flow.mdx
CryptAm Dec 13, 2025
6ec2813
Update understanding-the-onchain-tech-stack.mdx
CryptAm Dec 13, 2025
2073d5a
Update anatomy.mdx
CryptAm Dec 13, 2025
69bc68c
Update basic-types.mdx
CryptAm Dec 13, 2025
5c87954
Update deployment-in-remix.mdx
CryptAm Dec 13, 2025
1a298b6
Update exercise-basics.mdx
CryptAm Dec 13, 2025
1a20f0b
Update hello-world.mdx
CryptAm Dec 13, 2025
f6373d8
Update introduction-to-contracts.mdx
CryptAm Dec 13, 2025
8e87b6d
Update introduction-to-remix.mdx
CryptAm Dec 13, 2025
eb616fc
Update introduction.mdx
CryptAm Dec 13, 2025
6bad90f
Update overview.mdx
CryptAm Dec 13, 2025
6e89aac
Update remix-guide.mdx
CryptAm Dec 13, 2025
24ce7bb
Update step-by-step.mdx
CryptAm Dec 13, 2025
b126708
Update video-tutorial.mdx
CryptAm Dec 13, 2025
ee94bb9
Update how-storage-works-video.mdx
CryptAm Dec 13, 2025
c2c9640
Update how-storage-works.mdx
CryptAm Dec 13, 2025
d86b015
Update simple-storage-sbs.mdx
CryptAm Dec 14, 2025
4c80d81
Update simple-storage-video.mdx
CryptAm Dec 14, 2025
b535619
Update storage-exercise.mdx
CryptAm Dec 14, 2025
4dd02f9
Update structs-exercise.mdx
CryptAm Dec 14, 2025
db1fe01
Update structs-sbs.mdx
CryptAm Dec 14, 2025
75b0431
Update structs-vid.mdx
CryptAm Dec 14, 2025
7a1991f
Update analyzing-erc-20-vid.mdx
CryptAm Dec 14, 2025
b7431d7
Update erc-20-exercise.mdx
CryptAm Dec 14, 2025
b1f3efd
Update erc-20-standard.mdx
CryptAm Dec 14, 2025
4b41771
Update erc-20-testing-vid.mdx
CryptAm Dec 14, 2025
26e9917
Update erc-20-token-sbs.mdx
CryptAm Dec 14, 2025
9a75e1a
Update openzeppelin-erc-20-vid.mdx
CryptAm Dec 14, 2025
efef70e
Update erc-721-exercise.mdx
CryptAm Dec 14, 2025
983be2a
Update erc-721-on-opensea-vid.mdx
CryptAm Dec 14, 2025
1ad528e
Update erc-721-sbs.mdx
CryptAm Dec 14, 2025
4fe14a3
Update erc-721-standard-video.mdx
CryptAm Dec 14, 2025
8719689
Update erc-721-standard.mdx
CryptAm Dec 14, 2025
90e7e87
Update implementing-an-erc-721-vid.mdx
CryptAm Dec 14, 2025
d9dc931
Update openzeppelin-erc-721-vid.mdx
CryptAm Dec 14, 2025
43de90b
Update intro-to-tokens-vid.mdx
CryptAm Dec 14, 2025
b7e2e7c
Update misconceptions-about-tokens-vid.mdx
CryptAm Dec 14, 2025
e94014d
Update tokens-overview.mdx
CryptAm Dec 14, 2025
f6a15d2
Update creating-a-minimal-token-vid.mdx
CryptAm Dec 14, 2025
0b38bd7
Update minimal-token-sbs.mdx
CryptAm Dec 14, 2025
dc8b853
Update minimal-tokens-exercise.mdx
CryptAm Dec 14, 2025
9175021
Update transferring-a-minimal-token-vid.mdx
CryptAm Dec 14, 2025
d4f5b78
Update complex-onchain-nfts.mdx
CryptAm Dec 14, 2025
05c1de4
Update dynamic-nfts.mdx
CryptAm Dec 14, 2025
03f13d3
Update signature-mint.mdx
CryptAm Dec 14, 2025
1b11b0e
Update simple-onchain-nfts.mdx
CryptAm Dec 14, 2025
b0e50b7
Update thirdweb-unreal-nft-items.mdx
CryptAm Dec 14, 2025
2b28990
Update build-deposit-to-morpho-tx.mdx
CryptAm Dec 14, 2025
7fb5410
Update build-withdraw-from-morpho-tx.mdx
CryptAm Dec 14, 2025
0d89560
Update fetch-onramp-config.mdx
CryptAm Dec 14, 2025
7fba9d5
Update fetch-onramp-options.mdx
CryptAm Dec 14, 2025
970d11a
Update fetch-onramp-quote.mdx
CryptAm Dec 14, 2025
f0ce33c
Update fetch-onramp-transaction-status.mdx
CryptAm Dec 14, 2025
f300d8f
Update get-onramp-buy-url.mdx
CryptAm Dec 14, 2025
a2ee58a
Update setup-onramp-event-listeners.mdx
CryptAm Dec 14, 2025
f49ce98
Update get-address.mdx
CryptAm Dec 14, 2025
91fb306
Update get-attestations.mdx
CryptAm Dec 14, 2025
f1f2747
Update get-avatar.mdx
CryptAm Dec 14, 2025
c6c8ea6
Update get-avatars.mdx
CryptAm Dec 14, 2025
a1fd6f4
Update get-name.mdx
CryptAm Dec 14, 2025
c4eecc6
Update get-names.mdx
CryptAm Dec 14, 2025
df1f3cf
Update format-amount.mdx
CryptAm Dec 14, 2025
6952db3
Update is-valid-aa-entrypoint.mdx
CryptAm Dec 14, 2025
d3e82e1
Update is-wallet-a-coinbase-smart-wallet.mdx
CryptAm Dec 14, 2025
6abcfa3
Update use-build-deposit-to-morpho-tx.mdx
CryptAm Dec 14, 2025
5d65a24
Update use-build-withdraw-from-morpho-tx.mdx
CryptAm Dec 14, 2025
015166d
Update use-earn-context.mdx
CryptAm Dec 14, 2025
956c60b
Update use-morpho-vault.mdx
CryptAm Dec 14, 2025
1a19b64
Update use-address.mdx
CryptAm Dec 14, 2025
2bea1f3
Update use-avatar.mdx
CryptAm Dec 14, 2025
3f1356d
Update use-avatars.mdx
CryptAm Dec 14, 2025
842e706
Update use-name.mdx
CryptAm Dec 14, 2025
9b0041c
Update use-names.mdx
CryptAm Dec 14, 2025
5693d1a
Update use-mint-details.mdx
CryptAm Dec 14, 2025
3ca347a
Update use-token-details.mdx
CryptAm Dec 14, 2025
4f2441a
Update ai-prompting-guide.mdx
CryptAm Dec 14, 2025
fede717
Update contributing.mdx
CryptAm Dec 14, 2025
4dd4b73
Update manual-installation.mdx
CryptAm Dec 15, 2025
258205e
Update overview.mdx
CryptAm Dec 15, 2025
8c0cc05
Update quickstart-guide.mdx
CryptAm Dec 15, 2025
1dc7f53
Update troubleshooting.mdx
CryptAm Dec 15, 2025
d287151
Update onchainkit-provider.mdx
CryptAm Dec 15, 2025
7f0e48e
Update themes.mdx
CryptAm Dec 15, 2025
2fe15c2
Update wagmi-viem-integration.mdx
CryptAm Dec 15, 2025
ea7d163
Update bridge.mdx
CryptAm Dec 15, 2025
0bab6e6
Update buy.mdx
CryptAm Dec 15, 2025
b74533f
Update checkout.mdx
CryptAm Dec 15, 2025
cb624dc
Update connected.mdx
CryptAm Dec 15, 2025
8c9911c
Update earn.mdx
CryptAm Dec 15, 2025
b09d30c
Update fund-button.mdx
CryptAm Dec 15, 2025
6c0a511
Update fund-card.mdx
CryptAm Dec 15, 2025
b4192ea
Update address.mdx
CryptAm Dec 15, 2025
2ecc279
Update avatar.mdx
CryptAm Dec 15, 2025
6113c6b
Update badge.mdx
CryptAm Dec 15, 2025
80ea52c
Update identity-card.mdx
CryptAm Dec 15, 2025
cebf79b
Update identity.mdx
CryptAm Dec 15, 2025
d96bd64
Update name.mdx
CryptAm Dec 15, 2025
cc43cb6
Update socials.mdx
CryptAm Dec 15, 2025
5ecd34e
Update useAddFrame.mdx
CryptAm Dec 15, 2025
af6c7dc
Update useAuthenticate.mdx
CryptAm Dec 15, 2025
93e5bca
Update useClose.mdx
CryptAm Dec 15, 2025
ae2066c
Update useComposeCast.mdx
CryptAm Dec 15, 2025
4f51b77
Update useMiniKit.mdx
CryptAm Dec 15, 2025
e96f38f
Update useNotification.mdx
CryptAm Dec 15, 2025
e170e70
Update useOpenUrl.mdx
CryptAm Dec 15, 2025
e115213
Update usePrimaryButton.mdx
CryptAm Dec 15, 2025
d6a8aae
Update useViewCast.mdx
CryptAm Dec 15, 2025
b318025
Update useViewProfile.mdx
CryptAm Dec 15, 2025
659168b
Update overview.mdx
CryptAm Dec 15, 2025
6a6a081
Update provider-and-initialization.mdx
CryptAm Dec 15, 2025
257803d
Update nft-card.mdx
CryptAm Dec 15, 2025
df4b819
Update nft-mint-card.mdx
CryptAm Dec 15, 2025
d03624d
Update signature.mdx
CryptAm Dec 15, 2025
34883c3
Update swap-settings.mdx
CryptAm Dec 15, 2025
b97586d
Update swap.mdx
CryptAm Dec 15, 2025
c57d8b1
Update token-chip.mdx
CryptAm Dec 16, 2025
30aef73
Update token-image.mdx
CryptAm Dec 16, 2025
229e150
Update token-row.mdx
CryptAm Dec 16, 2025
5a21a6b
Update token-search.mdx
CryptAm Dec 16, 2025
ec9daf1
Update token-select-dropdown.mdx
CryptAm Dec 16, 2025
ee3ede9
Update transaction.mdx
CryptAm Dec 16, 2025
a29c71e
Update wallet-dropdown-basename.mdx
CryptAm Dec 16, 2025
619bd59
Update wallet-dropdown-disconnect.mdx
CryptAm Dec 16, 2025
a0e44b2
Update wallet-dropdown-fund-link.mdx
CryptAm Dec 16, 2025
9ae1579
Update wallet-dropdown-link.mdx
CryptAm Dec 16, 2025
6839379
Update wallet-island.mdx
CryptAm Dec 16, 2025
db202c2
Update wallet-modal.mdx
CryptAm Dec 16, 2025
e724025
Update wallet.mdx
CryptAm Dec 16, 2025
08cdb8b
Update nft-card.mdx
CryptAm Dec 16, 2025
4bfd58b
Update nft-mint-card.mdx
CryptAm Dec 16, 2025
0ccac8d
Update types.mdx
CryptAm Dec 16, 2025
54ea596
Update erc20-paymaster.mdx
CryptAm Dec 16, 2025
1df0b1d
Update errors.mdx
CryptAm Dec 16, 2025
9bce581
Update gasless-transactions-with-paymaster.mdx
CryptAm Dec 16, 2025
3afc5a1
Update quickstart-guide.mdx
CryptAm Dec 16, 2025
c9e3393
Update quickstart-headless.mdx
CryptAm Dec 16, 2025
e69c645
Update security.mdx
CryptAm Dec 16, 2025
e07a271
Update troubleshooting.mdx
CryptAm Dec 16, 2025
9b2bc92
Update welcome.mdx
CryptAm Dec 16, 2025
92a4719
Update signature.mdx
CryptAm Dec 16, 2025
2aa6fd1
Update types.mdx
CryptAm Dec 16, 2025
8a9236f
Update swap-settings.mdx
CryptAm Dec 16, 2025
4aaea0b
Update swap.mdx
CryptAm Dec 16, 2025
1bfbadb
Update types.mdx
CryptAm Dec 16, 2025
283e34e
Update onchain-commerce-app.mdx
CryptAm Dec 16, 2025
bd6a922
Update onchain-nft-app.mdx
CryptAm Dec 16, 2025
1592ebc
Update onchain-social-profile.mdx
CryptAm Dec 16, 2025
eea9da0
Update format-amount.mdx
CryptAm Dec 16, 2025
f0a245b
Update token-chip.mdx
CryptAm Dec 16, 2025
2d141c5
Update token-image.mdx
CryptAm Dec 16, 2025
76ddb37
Update token-row.mdx
CryptAm Dec 16, 2025
bcd662c
Update token-search.mdx
CryptAm Dec 16, 2025
8838c07
Update token-select-dropdown.mdx
CryptAm Dec 16, 2025
575b3e9
Update types.mdx
CryptAm Dec 16, 2025
de4635f
Update transaction.mdx
CryptAm Dec 16, 2025
4145095
Update types.mdx
CryptAm Dec 16, 2025
5ba3613
Update is-valid-aa-entrypoint.mdx
CryptAm Dec 16, 2025
f54f350
Update is-wallet-a-coinbase-smart-wallet.mdx
CryptAm Dec 16, 2025
8eabbb6
Update types.mdx
CryptAm Dec 16, 2025
3424340
Update wallet-dropdown-basename.mdx
CryptAm Dec 16, 2025
d865255
Update wallet-dropdown-disconnect.mdx
CryptAm Dec 16, 2025
7221e64
Update wallet-dropdown-fund-link.mdx
CryptAm Dec 16, 2025
0f4e6b6
Update wallet-dropdown-link.mdx
CryptAm Dec 16, 2025
02e1705
Update wallet-island.mdx
CryptAm Dec 16, 2025
3e8e901
Update wallet-modal.mdx
CryptAm Dec 16, 2025
a25817b
Update wallet.mdx
CryptAm Dec 16, 2025
0c45a78
Update products.mdx
CryptAm Dec 18, 2025
4975caf
Update use-cases.mdx
CryptAm Dec 18, 2025
10cc812
Update onchain-registry-api.mdx
CryptAm Dec 18, 2025
9fff8e2
Update accept-payments.mdx
CryptAm Dec 18, 2025
30a2925
Update x402-agents.mdx
CryptAm Dec 18, 2025
be45873
Update transaction-finality.mdx
CryptAm Dec 18, 2025
f7ca9f4
Update exercise-contracts.mdx
CryptAm Dec 18, 2025
70f4c57
Update exercise-contracts.mdx
CryptAm Dec 18, 2025
857b2c1
Update accept-payments.mdx
CryptAm Dec 18, 2025
78c8222
Update welcome.mdx
CryptAm Dec 18, 2025
91cab31
Update learning-objectives.mdx
CryptAm Dec 18, 2025
4ddfd2d
Update deploy-with-foundry.mdx
CryptAm Dec 18, 2025
6038994
Update inheritance-exercise.mdx
CryptAm Dec 18, 2025
328043d
Update structs-exercise.mdx
CryptAm Dec 18, 2025
2816e6a
Update inspect-txn-simulation.mdx
CryptAm Dec 18, 2025
efb1697
Update popup-tips.mdx
CryptAm Dec 18, 2025
f3cb4bb
Update erc20-paymasters.mdx
CryptAm Dec 18, 2025
916a910
Update paymasters.mdx
CryptAm Dec 18, 2025
c0b9612
Update batch-transactions.mdx
CryptAm Dec 18, 2025
25516be
Update magic-spend.mdx
CryptAm Dec 18, 2025
6d4d53c
Update spend-permissions.mdx
CryptAm Dec 18, 2025
6a31d97
Update sub-accounts.mdx
CryptAm Dec 18, 2025
72de0f5
Update ai-tools-available-for-devs.mdx
CryptAm Dec 18, 2025
97bd3d0
Update docs.json
CryptAm Dec 19, 2025
027300d
Update docs.json
CryptAm Dec 19, 2025
bc71b33
Update launch-token.mdx
CryptAm Dec 19, 2025
34d2ba6
Update sign-in-with-base.mdx
CryptAm Dec 19, 2025
5ec34d8
Update migrate-existing-apps.mdx
CryptAm Dec 19, 2025
312c2d3
Update overview.mdx
CryptAm Dec 19, 2025
b3a39b9
Update docs.json
CryptAm Dec 19, 2025
7f712e9
Update ethereum-dev-overview-vid.mdx
CryptAm Dec 19, 2025
97a4f13
Update ai-prompting.mdx
CryptAm Dec 19, 2025
9559653
Update hardhat-forking.mdx
CryptAm Dec 19, 2025
a443dea
Update deployment-to-testnet-exercise.mdx
CryptAm Dec 19, 2025
7d55ad9
Update deployment-to-testnet-exercise.mdx
CryptAm Dec 19, 2025
7b8bb50
Update arrays-exercise.mdx
CryptAm Dec 19, 2025
06f6ef2
Update basic-functions-exercise.mdx
CryptAm Dec 19, 2025
196fae3
Update control-structures-exercise.mdx
CryptAm Dec 19, 2025
64a62bf
Update error-triage-exercise.mdx
CryptAm Dec 19, 2025
4d4b166
Update imports-exercise.mdx
CryptAm Dec 19, 2025
801f7fd
Update inheritance-exercise.mdx
CryptAm Dec 19, 2025
a7a814a
Update mappings-exercise.mdx
CryptAm Dec 19, 2025
84683a5
Update new-keyword-exercise.mdx
CryptAm Dec 19, 2025
f44da9b
Update exercise-basics.mdx
CryptAm Dec 19, 2025
6d5bd90
Update storage-exercise.mdx
CryptAm Dec 19, 2025
d4d6a86
Update structs-exercise.mdx
CryptAm Dec 19, 2025
ece81dc
Update erc-20-exercise.mdx
CryptAm Dec 19, 2025
d30075f
Update erc-721-exercise.mdx
CryptAm Dec 19, 2025
e103ee4
Update minimal-tokens-exercise.mdx
CryptAm Dec 19, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
176 changes: 88 additions & 88 deletions README.md

Large diffs are not rendered by default.

146 changes: 73 additions & 73 deletions content-instructions.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,42 @@
# Mintlify technical writing rule
# Правила технического письма Mintlify.

You are an AI writing assistant specialized in creating exceptional technical documentation using Mintlify components and following industry-leading technical writing practices.
Вы — AI-ассистент, специализирующийся на создании качественной технической документации с использованием компонентов Mintlify и соблюдением лучших практик технического письма.

## Core writing principles
## Основные принципы письма

### Language and style requirements
### Требования к языку и стилю

- Use clear, direct language appropriate for technical audiences
- Write in second person ("you") for instructions and procedures
- Use active voice over passive voice
- Employ present tense for current states, future tense for outcomes
- Avoid jargon unless necessary and define terms when first used
- Maintain consistent terminology throughout all documentation
- Keep sentences concise while providing necessary context
- Use parallel structure in lists, headings, and procedures
- Используйте ясный, прямой язык, подходящий для технической аудитории
- Пишите во втором лице ("вы") для инструкций и процедур
- Используйте активный залог вместо пассивного
- Используйте настоящее время для описания текущих состояний и будущее — для ожидаемых результатов
- Избегайте жаргона, если он не необходим, и определяйте термины при первом использовании
- Сохраняйте единообразную терминологию во всей документации
- Сохраняйте предложения краткими, обеспечивая необходимый контекст
- Используйте параллельную структуру в списках, заголовках и процедурах

### Content organization standards
### Стандарты организации контента

- Lead with the most important information (inverted pyramid structure)
- Use progressive disclosure: basic concepts before advanced ones
- Break complex procedures into numbered steps
- Only include prerequisites and context before instructions when necessary for instructions to be understood
- Provide expected outcomes for each major step
- Use descriptive, keyword-rich headings for navigation and SEO
- Group related information logically with clear section breaks
- Начинайте с самой важной информации (структура перевернутой пирамиды)
- Применяйте прогрессивное раскрытие — сначала базовые концепции, затем продвинутые
- Разбивайте сложные процедуры на нумерованные шаги
- Включайте предварительные требования и контекст перед инструкциями только когда это необходимо для понимания инструкций
- Предоставляйте ожидаемые результаты для каждого основного шага
- Используйте описательные, богатые ключевыми словами заголовки для навигации и SEO
- Группируйте связанную информацию логично с четкими разрывами разделов

### User-centered approach
### Пользовательский подход

- Focus on user goals and outcomes rather than system features
- Anticipate common questions and address them proactively
- Include troubleshooting for likely failure points
- Write for scannability with clear headings, lists, and white space
- Include verification steps to confirm success
- Фокусируйтесь на целях пользователей и результатах, а не на функциях системы
- Предвосхищайте распространенные вопросы и решайте их проактивно
- Включайте устранение неполадок для вероятных точек сбоя
- Пишите текст так, чтобы его было удобно просматривать — используйте чёткие заголовки, списки и достаточные отступы
- Включайте шаги проверки для подтверждения успеха


## Required page structure
## Обязательная структура страницы

Every documentation page must begin with YAML frontmatter:
Каждая страница документации должна начинаться с YAML frontmatter:

```yaml
---
Expand All @@ -45,49 +45,49 @@ description: "Concise description explaining page purpose and value"
---
```

## Content quality standards

### Code examples requirements
- Every code block must have a filename or a title
- if filename, add filename after language (e.g. ```typescript page.tsx```)
- if title, add Title followed by the title (e.g. ```typescript Title example```)
- Highlight the most relevant lines of the codeblock using ```typescript highlight={1-2,5}```
- Code blocks longer than 7 lines should:
- have line numbers by adding `lines` to the first line of the codeblock (e.g. ```typescript lines```)
- be marked as `expandable` by adding to the first line of the codeblock
- use `wrap` to prevent horizontal scrolling of codeblocks
- Always include complete, runnable examples that users can copy and execute
- Show proper error handling and edge case management
- Use realistic data instead of placeholder values
- Include expected outputs and results for verification
- Add explanatory comments for complex logic
- Never include real API keys or secrets in code examples

### API documentation requirements

- Document all parameters including optional ones with clear descriptions
- Show both success and error response examples with realistic data
- Include rate limiting information with specific limits
- Provide authentication examples showing proper format
- Explain all HTTP status codes and error handling
- Cover complete request/response cycles

### Accessibility requirements

- Include descriptive alt text for all images and diagrams
- Use specific, actionable link text instead of "click here"
- Ensure proper heading hierarchy starting with H2
- Provide keyboard navigation considerations
- Use sufficient color contrast in examples and visuals
- Structure content for easy scanning with headers and lists

## Component selection logic

- Use **Steps** for procedures and sequential instructions
- Use **Tabs** for platform-specific content or alternative approaches
- Use **CodeGroup** when showing the same concept in multiple programming languages or frameworks
- Use **Accordions** for progressive disclosure of information
- Use **RequestExample/ResponseExample** specifically for API endpoint documentation
- Use **ParamField** for API parameters, **ResponseField** for API responses
- Use **Expandable** for nested object properties or hierarchical information
## Стандарты качества контента

### Требования к примерам кода
- Каждый блок кода должен иметь имя файла или заголовок
- если имя файла, добавьте его после языка (например, ```typescript page.tsx```)
- если заголовок, добавьте Title с последующим заголовком (например, ```typescript Title example```)
- Выделяйте наиболее релевантные строки блока кода с помощью ```typescript highlight={1-2,5}```
- Блоки кода длиннее 7 строк должны:
- иметь номера строк путем добавления `lines` к первой строке блока кода (например, ```typescript lines```)
- быть помечены как `expandable` путем добавления к первой строке блока кода
- используйте `wrap` для предотвращения горизонтальной прокрутки блоков кода
- Всегда включайте полные, запускаемые примеры, которые пользователи могут скопировать и выполнить
- Показывайте правильную обработку ошибок и управление граничными случаями
- Используйте реалистичные данные вместо значений-заполнителей
- Включайте ожидаемые выводы и результаты для проверки
- Добавляйте пояснительные комментарии для сложной логики
- Никогда не включайте реальные API-ключи или секреты в примеры кода

### Требования к документации API

- Документируйте все параметры, включая опциональные, с четкими описаниями
- Показывайте примеры как успешных, так и ошибочных ответов с реалистичными данными
- Включайте информацию об ограничении частоты запросов с конкретными лимитами
- Предоставляйте примеры аутентификации, показывающие правильный формат
- Объясняйте все HTTP статус-коды и обработку ошибок
- Охватывайте полные циклы запросов/ответов

### Требования доступности

- Включайте описательный alt-текст для всех изображений и диаграмм
- Используйте осмысленные и действенные тексты ссылок вместо фраз вроде «нажмите здесь»
- Обеспечьте правильную иерархию заголовков, начиная с H2
- Предусматривайте возможности навигации с клавиатуры
- Используйте достаточную контрастность цветов в примерах и визуальных элементах
- Структурируйте контент для легкого просмотра с помощью заголовков и списков

## Логика выбора компонентов

- Используйте **Steps** для процедур и последовательных инструкций
- Используйте **Tabs** для платформо-специфичного контента или альтернативных подходов
- Используйте **CodeGroup** при показе одной концепции на нескольких языках программирования или фреймворках
- Используйте **Accordions** для прогрессивного раскрытия информации
- Используйте **RequestExample/ResponseExample** специально для документации API endpoints
- Используйте **ParamField** для параметров API, **ResponseField** для ответов API
- Используйте **Expandable** для вложенных свойств объектов или иерархической информации

Loading