Skip to content

Commit 5f0d828

Browse files
authored
docs: add guide template (#1990)
1 parent c071476 commit 5f0d828

File tree

2 files changed

+72
-1
lines changed

2 files changed

+72
-1
lines changed

docs/pages/guide-template.mdx

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: title [Action-oriented, outcome-focused title]
3+
description: Short description of the guide
4+
slug: wallets/...
5+
---
6+
7+
[1-2 sentences describing the developer outcome]
8+
9+
- This should answer what this feature/guide is and when to use it
10+
- Remember to focus on developer outcomes, not implementation details
11+
- If more in-depth explanation is needed - that info should be in an explainer doc and linked to or advanced section
12+
13+
## How it works
14+
15+
1-2 paragraphs describing the how it works
16+
17+
[Any technical deep details that are **required** to successfully test] - this should NOT be explainers or deep dives that expose complexity. Only required info
18+
19+
[Call out any defaults we are using or assumptions we are making - point to advanced section for followups on these points]
20+
21+
## Prerequisites
22+
23+
List any setup or knowledge required:
24+
25+
- Alchemy project + dashboard access
26+
- Relevant SDK or API setup
27+
- Auth keys or config initialized
28+
- Assumptions or constraints on framework or version
29+
30+
Example:
31+
32+
- API key from your [dashboard](https://dashboard.alchemy.com/apps)
33+
- [Smart Wallets installed and configured in your project](/docs/wallets/pages/react/setup.mdx).
34+
- [A "pay gas with any token" policy](https://dashboard.alchemy.com/gas-manager/policy/create).
35+
36+
## Implementation
37+
38+
<Tabs>
39+
<Tab title="React">
40+
<Info>Required SDK version: ^v4.59.1</Info>
41+
<Markdown src="react.mdx" />
42+
</Tab>
43+
<Tab title="Javascript">
44+
<Info>Required SDK version: ^v4.59.1</Info>
45+
<Markdown src="client.mdx" />
46+
</Tab>
47+
<Tab title="API">
48+
See the [`wallet_prepareCalls` API
49+
reference](/docs/wallets/api/smart-wallets/wallet-api-endpoints/wallet-api-endpoints/wallet-prepare-calls)
50+
for full descriptions of the parameters used in the following examples.
51+
<Markdown src="api-postop.mdx" />
52+
</Tab>
53+
</Tabs>
54+
55+
## Advanced
56+
57+
<Accordion title="Advanced section 1">
58+
[Details about advanced options / implementations / explainers]
59+
</Accordion>
60+
<Accordion title="Advanced section 2">
61+
[Details about advanced options / implementations / explainers]
62+
</Accordion>
63+
64+
## Next steps
65+
66+
- Build more: [Next logical How-to Guide or step]
67+
- e.g. now that you’ve logged users in with email, send a transaction.
68+
- Learn more: [Recipe that includes this step]
69+
- Reference: [API Reference]
70+
- Explanations**:** [Conceptual background or technical deep dive]
71+
- [Link to related troubleshooting]

0 commit comments

Comments
 (0)