Skip to content

Commit 40c1f3a

Browse files
authored
docs: move home to / and add readme for wallets tab (#57)
* docs: move homepage to / * docs: add wallets directory to be used for account kits docs * docs: update readme to reflect new file structure * ci: update account kit docs to use new wallets directory --------- Co-authored-by: dslovinsky <dslovinsky@users.noreply.github.com>
1 parent 34294c8 commit 40c1f3a

File tree

6 files changed

+32
-27
lines changed

6 files changed

+32
-27
lines changed

.github/actions/sparse-checkout-docs/action.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: "Add aa-sdk docs to fern"
2-
description: "Checks out aa-sdk repository with sparse checkout and copies docs to fern/docs/account-kit"
2+
description: "Checks out aa-sdk repository with sparse checkout and copies docs to fern/wallets"
33

44
runs:
55
using: "composite"
@@ -16,6 +16,6 @@ runs:
1616
- name: Copy docs to workspace and insert into fern
1717
shell: bash
1818
run: |
19-
mkdir -p fern/docs/account-kit
20-
cp -r aa-sdk/docs/* fern/docs/account-kit
21-
fern/docs/account-kit/scripts/insert-docs.sh
19+
mkdir -p fern/wallets
20+
cp -r aa-sdk/docs/* fern/wallets
21+
fern/wallets/scripts/insert-docs.sh

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Thank you for your interest in contributing to Alchemy's documentation! This gui
3838

3939
### Account Kit Documentation
4040

41-
Account Kit documentation is maintained in the [aa-sdk repository](https://github.com/alchemyplatform/aa-sdk). See its [README](https://github.com/alchemyplatform/aa-sdk/blob/ds/fern-compatible-docs/docs/README.md) for contribution guidelines.
41+
Account Kit documentation is maintained in the [aa-sdk repository](https://github.com/alchemyplatform/aa-sdk). See its [README](https://github.com/alchemyplatform/aa-sdk/blob/main/docs/README.md) for contribution guidelines.
4242

4343
## Making Changes
4444

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ The latest documentation lives on https://alchemy.docs.buildwithfern.com/home
1212
│ ├── openapi/ # REST API definitions (OpenAPI)
1313
│ └── openrpc/ # JSON-RPC API definitions (OpenRPC)
1414
├── fern/
15-
│ ├── docs/ # Written documentation (MDX)
15+
│ ├── <tab>/ # Written documentation for that tab (MDX)
1616
│ └── docs.yml # Navigation and structure config
17-
└── docs/ # Generated files - Do NOT make changes here
17+
└── build/ # Generated files - Do NOT make changes here
1818
```
1919

2020
## Getting Started

fern/docs.yml

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ colors:
3535
typography:
3636
bodyFont:
3737
name: PPNeueMontreal
38-
paths:
38+
paths:
3939
- path: assets/fonts/PPNeueMontreal-Regular.woff2
4040
weight: 500
4141
style: normal
@@ -60,33 +60,36 @@ js:
6060
experimental:
6161
openapi-parser-v3: true
6262
mdx-components:
63-
# Account Kit components are auto-generated here
63+
# Account Kit components are auto-generated here
6464

6565
navbar-links:
6666
- type: filled
6767
text: Sign in to Alchemy
68-
url: https://register-developer.sandbox.alchemy.com/
68+
url: https://register-developer.sandbox.alchemy.com/
6969

7070
tabs:
7171
home:
7272
display-name: Home
7373
skip-slug: true
7474
wallets:
7575
display-name: Wallets
76-
slug: wallets
76+
slug: wallets
7777
tutorials:
7878
slug: /docs
7979
display-name: Tutorials
8080
api-reference:
8181
slug: /reference
82-
display-name: API Reference
82+
display-name: API Reference
8383

8484
navigation:
8585
- tab: home
8686
layout:
8787
- page: Home
88-
path: home/home.mdx
89-
# Account Kit docs are auto-generated here
88+
slug: /
89+
path: home/index.mdx
90+
91+
# Account Kit docs are auto-generated here
92+
9093
- tab: tutorials
9194
layout:
9295
- section: 👋 Welcome
@@ -343,7 +346,7 @@ navigation:
343346
- page: How does Solidity work with the EVM?
344347
path: >-
345348
tutorials/alchemy-university/solidity-basics/how-does-solidity-work.mdx
346-
- page: 'Solidity vs. JavaScript: Similarities & Differences'
349+
- page: "Solidity vs. JavaScript: Similarities & Differences"
347350
path: >-
348351
tutorials/alchemy-university/solidity-basics/solidity-vs-javascript.mdx
349352
- page: How do Solidity functions work?
@@ -430,9 +433,9 @@ navigation:
430433
path: >-
431434
tutorials/creating-smart-contracts/hello-world-solana-program/integrating-your-solana-program-with-a-web3-application.mdx
432435
slug: hello-world-solana-program
433-
- section: 'NFT Minter Tutorial: How to Create a Full Stack DApp'
436+
- section: "NFT Minter Tutorial: How to Create a Full Stack DApp"
434437
contents:
435-
- page: 'NFT Minter Tutorial: How to Create a Full Stack DApp'
438+
- page: "NFT Minter Tutorial: How to Create a Full Stack DApp"
436439
path: >-
437440
tutorials/creating-smart-contracts/nft-minter-tutorial-how-to-create-a-full-stack-dapp/nft-minter.mdx
438441
- page: How to Build an NFT Website
@@ -457,7 +460,7 @@ navigation:
457460
path: >-
458461
tutorials/creating-smart-contracts/how-to-create-an-nft-on-ethereum-tutorial/how-to-create-erc-1155-tokens.mdx
459462
slug: how-to-create-an-nft-on-ethereum-tutorial
460-
- page: 'Arbitrum NFTs: Creating and Deploying ERC-721'
463+
- page: "Arbitrum NFTs: Creating and Deploying ERC-721"
461464
path: >-
462465
tutorials/creating-smart-contracts/arbitrum-nfts-creating-and-deploying-erc-721.mdx
463466
- page: How to Build a Solana NFT Collection
@@ -726,7 +729,7 @@ navigation:
726729
- page: How to Create an NFT Game
727730
path: >-
728731
tutorials/nfts/how-to-create-an-nft-game/how-to-create-an-nft-game-smart-contract.mdx
729-
- page: 'Part 2: How to Create an NFT Game Frontend'
732+
- page: "Part 2: How to Create an NFT Game Frontend"
730733
path: >-
731734
tutorials/nfts/how-to-create-an-nft-game/how-to-create-an-nft-game-frontend.mdx
732735
slug: how-to-create-an-nft-game
@@ -862,7 +865,7 @@ navigation:
862865
- page: How to Get On-chain Events on Ethereum
863866
path: >-
864867
tutorials/transactions/on-chain-events/how-to-get-on-chain-events.mdx
865-
- page: 'Understanding Logs: Deep Dive into eth_getLogs'
868+
- page: "Understanding Logs: Deep Dive into eth_getLogs"
866869
path: >-
867870
tutorials/transactions/on-chain-events/deep-dive-into-eth-getlogs.mdx
868871
slug: on-chain-events
@@ -1053,7 +1056,7 @@ navigation:
10531056
- page: What is Archive Data on Ethereum?
10541057
path: >-
10551058
tutorials/understanding-the-evm/what-is-archive-data-on-ethereum.mdx
1056-
- page: 'Internal Playbook: Upgrading Ethereum Nodes'
1059+
- page: "Internal Playbook: Upgrading Ethereum Nodes"
10571060
path: >-
10581061
tutorials/understanding-the-evm/internal-playbook-upgrading-ethereum-nodes.mdx
10591062
- page: How to Calculate Ethereum Miner Rewards
@@ -1216,7 +1219,7 @@ navigation:
12161219
path: api-reference/alchemy-rollups/operating-your-rollup.mdx
12171220
- page: Rollups FAQ
12181221
path: api-reference/alchemy-rollups/rollups-faq.mdx
1219-
- page: 'Tutorial: Bridging Assets'
1222+
- page: "Tutorial: Bridging Assets"
12201223
path: api-reference/alchemy-rollups/bridge-contract-address.mdx
12211224
slug: alchemy-rollups
12221225
- section: 🧠 Data
@@ -1285,7 +1288,7 @@ navigation:
12851288
api-name: blocks
12861289
flattened: true
12871290
- api: Transactions Receipts Endpoints
1288-
openrpc: ../build/api-specs/alchemy/json-rpc/transactions-receipt.json
1291+
openrpc: ../build/api-specs/alchemy/json-rpc/transactions-receipt.json
12891292
slug: utility-apis
12901293
- section: 🍊 Subgraphs
12911294
contents:

fern/home/home.mdx renamed to fern/home/index.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: The Alchemy Developer Hub
2+
title: The Alchemy Developer Hub
33
layout: custom
44
hide-feedback: true
55
---
66

77
<style>
8-
{`
8+
{`
99
/* ----- GENERAL LAYOUT ----- */
1010
.fern-background {
1111
background-color: rgba(var(--background), 1);
@@ -533,7 +533,7 @@ hide-feedback: true
533533
href="/"
534534
>
535535
Deploy and get access to millions of developers.
536-
536+
537537
<img src="../assets/diagram.png" class="card-image" />
538538
</Card>
539539
</div>
@@ -581,5 +581,6 @@ hide-feedback: true
581581
</Card>
582582
</CardGroup>
583583
</div>
584+
584585
</div>
585-
</div>
586+
</div>

fern/wallets/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Account Kit documentation is maintained in the [aa-sdk repository](https://github.com/alchemyplatform/aa-sdk). See its [README](https://github.com/alchemyplatform/aa-sdk/blob/main/docs/README.md) for contribution guidelines.

0 commit comments

Comments
 (0)