Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
  •  
  •  
  •  
41 changes: 36 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,43 @@ git merge upstream/main
git push origin main
```

## Adding Images
## Adding Images and Videos

* Location: `fern/images`
* Steps:
* Place image files in the `fern/images/` directory
* Reference images from the markdown using its path within the images dir (don't include `/fern/images` in the path). See [Fern's docs](https://buildwithfern.com/learn/docs/content/write-markdown#images) on how to add to do so.
**All documentation assets are hosted on Cloudinary** - do NOT commit images/videos to Git.

### How to Add Assets

1. **Upload to Cloudinary**
* Sign-in to Cloudinary through Okta.
* Upload to the `docs/` folder
* Organize by section: `docs/api-reference/`, `docs/tutorials/`, `docs/guides/`, etc.

2. **Copy the Cloudinary URL**
* Click on your uploaded asset
* Copy the "Secure URL" (starts with `https://alchemyapi-res.cloudinary.com/`)

3. **Add to Your MDX File**
```markdown
![Descriptive alt text](https://alchemyapi-res.cloudinary.com/image/upload/v1234567890/docs/section/image.png)
```

### Best Practices

* ✅ Use descriptive filenames: `nft-api-dashboard.png`
* ✅ Optimize images before uploading (keep under 1 MB)
* ❌ Don't commit images to Git
* ❌ Don't use generic names like `image.png`
* ❌ Don't link to external CDNs (GitHub, Imgur, etc.)

### Video Embeds

```markdown
<embed
src="https://alchemyapi-res.cloudinary.com/raw/upload/v1234567890/docs/section/video.webm"
type="video/webm"
style={{ width: '100%' }}
/>
```

## Pull Request Guidelines

Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,18 @@ You can find the appropriate commands for running each in `package.json`

The project uses [Husky](https://typicode.github.io/husky) and [lint-staged](https://github.com/lint-staged/lint-staged) to run linting checks before commits.

## Assets (Images & Videos)

**All documentation assets are hosted on Cloudinary** - do NOT commit images/videos to the Git repository.

### Adding Images

1. Sign-in to Cloudinary through Okta and upload in the `docs/` folder
2. Copy the Cloudinary URL
3. Use in MDX: `![Alt text](https://alchemyapi-res.cloudinary.com/image/upload/v1234567890/docs/section/image.png)`

See [CONTRIBUTING.md](CONTRIBUTING.md#adding-images-and-videos) for detailed guidelines.

## Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to submit pull requests, report issues, and contribute to the documentation.
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed fern/api-reference/arbitrum/alchemy-sdk-js.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed fern/api-reference/arbitrum/favicon.ico
Binary file not shown.
Binary file removed fern/api-reference/astar/alchemy-sdk-js.png
Binary file not shown.
Binary file removed fern/api-reference/astar/favicon.ico
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed fern/api-reference/data/nft-api/alchemy-sdk-js.png
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed fern/api-reference/data/nft-api/favicon.ico
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed fern/api-reference/data/token-api/favicon.ico
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed fern/api-reference/introduction/0fa2754-image.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed fern/api-reference/introduction/bok_icon.png
Diff not rendered.
Diff not rendered.
3 changes: 0 additions & 3 deletions fern/api-reference/introduction/right_arow.svg
Diff not rendered.
Binary file removed fern/api-reference/op-mainnet/alchemy-sdk-js.png
Diff not rendered.
Binary file removed fern/api-reference/op-mainnet/favicon.ico
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file not shown.
Binary file removed fern/api-reference/polygon-pos/alchemy-sdk-js.png
Diff not rendered.
Binary file removed fern/api-reference/polygon-pos/favicon.ico
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed fern/api-reference/websockets/2cbc56a-image.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed fern/changelog/media/2025-09-18/app-centric.webm
Binary file not shown.
Binary file removed fern/images/001807b-Untitled_2.png
Diff not rendered.
Binary file removed fern/images/004cab1-wallet-ad.png
Diff not rendered.
Binary file removed fern/images/00eeb17-Untitled_13.png
Diff not rendered.
Binary file removed fern/images/00effc0-past.png
Diff not rendered.
Binary file removed fern/images/010de35-Untitled_25.png
Diff not rendered.
Binary file removed fern/images/011be99-image.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/01934a7-Untitled_8.png
Diff not rendered.
Binary file removed fern/images/01aff6a-Untitled_27.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/022dac3-image.png
Diff not rendered.
Binary file removed fern/images/0245262-Untitled.png
Diff not rendered.
Binary file removed fern/images/024f54d-test-accounts.png
Diff not rendered.
Binary file removed fern/images/034cc1e-pol.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/03b0a44-image.png
Diff not rendered.
Binary file removed fern/images/03b2ee6-Untitled_41.png
Diff not rendered.
Binary file removed fern/images/03e9567-image.png
Diff not rendered.
Binary file removed fern/images/0449f13-Phaver.png
Diff not rendered.
Binary file removed fern/images/045a9f4-Eth1.png
Diff not rendered.
Binary file removed fern/images/046f9be-transfer.png
Diff not rendered.
Binary file removed fern/images/0492920-eip-1559-senderc20.png
Diff not rendered.
Binary file removed fern/images/04db97a-token.png
Diff not rendered.
Binary file removed fern/images/0556198-Untitled_36.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/05d3fb3-nftObject.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/06b0d36-image.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/0753ed9-Sepolia_Faucet.png
Diff not rendered.
Binary file removed fern/images/08d01da-small-Untitled.jpeg
Diff not rendered.
Binary file removed fern/images/09530dc-small-Untitled_4.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/0a614b5-rin_nft.png
Diff not rendered.
Binary file removed fern/images/0aebd07-image.png
Diff not rendered.
Binary file removed fern/images/0af5f18-nft-metadata.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/0c06bc6-small-alchemy-circle-logo.png
Diff not rendered.
Binary file removed fern/images/0c0dd48-fo.png
Diff not rendered.
Binary file removed fern/images/0c16c62-image.png
Diff not rendered.
Binary file removed fern/images/0c1a314-opensea-azuki-sales.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/0c5349f-17...png
Diff not rendered.
Binary file removed fern/images/0c6abd8-Optimism_chain.png
Diff not rendered.
Binary file removed fern/images/0cb03ef-Untitled_40.png
Diff not rendered.
Binary file removed fern/images/0db0905-next.js.png
Diff not rendered.
Binary file removed fern/images/0e4f5eb-geroli.png
Diff not rendered.
Binary file removed fern/images/0e7ff54-new_app.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/0f1a2d4-coolio_bear.png
Diff not rendered.
Binary file removed fern/images/0f7b4bf-image.png
Diff not rendered.
Binary file removed fern/images/0fa2754-image.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/108a774-create_app.png
Diff not rendered.
Binary file removed fern/images/108c79e-Remix.png
Diff not rendered.
Binary file removed fern/images/10a0c2d-image.png
Diff not rendered.
Binary file removed fern/images/10c7560-supernode_uptime.png
Diff not rendered.
Binary file removed fern/images/1137a3b-Group_25.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/12aba4a-image_5.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/12f0f77-image_12.png
Diff not rendered.
Binary file removed fern/images/1350f22-image.png
Diff not rendered.
Binary file removed fern/images/1440f66-image.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/15ec3f5-Untitled_12.png
Diff not rendered.
Binary file removed fern/images/15f783a-create-alert.png
Diff not rendered.
Binary file removed fern/images/160c924-image.png
Diff not rendered.
Binary file removed fern/images/1627e38-Choose_package.jpeg
Diff not rendered.
Binary file removed fern/images/16bab29-mockV3.png
Diff not rendered.
Binary file removed fern/images/16cc726-Untitled_15.png
Diff not rendered.
Binary file removed fern/images/16cdd1a-404.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/1768fbc-small-Untitled.jpeg
Diff not rendered.
Binary file removed fern/images/1782bfe-Image_12-1-22_at_7.49_PM.jpeg
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/1882710-Untitled_3.png
Diff not rendered.
Binary file removed fern/images/18b73b3-Mekaverse.png
Diff not rendered.
Binary file removed fern/images/194e9df-thirdweb.png
Diff not rendered.
Binary file removed fern/images/1a5086b-image.png
Diff not rendered.
Binary file removed fern/images/1a604d7-image.png
Diff not rendered.
Binary file removed fern/images/1a652f4-image.png
Diff not rendered.
Binary file removed fern/images/1aaabe1-utils.png
Diff not rendered.
Binary file removed fern/images/1ae7acc-api_pol.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/1b4c436-meta.png
Diff not rendered.
Binary file removed fern/images/1bd93d2-image_5.png
Diff not rendered.
Binary file removed fern/images/1bda270-import-SK-mm-set.png
Diff not rendered.
Binary file removed fern/images/1be65ab-nada.lens.png
Diff not rendered.
Binary file removed fern/images/1c05d09-alchemy-signup.png
Diff not rendered.
Binary file removed fern/images/1c33226-Untitled_4.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/1ce2f78-Untitled_20.png
Diff not rendered.
Binary file removed fern/images/1d61a99-Image_11-22-22_at_7.15_AM.jpeg
Diff not rendered.
Binary file removed fern/images/1fd3752-2023-01-27_2-04-26.png
Diff not rendered.
Binary file removed fern/images/1fec764-offset-nonce-set.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/20c0edb-image_16.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/20d6171-polygon_config.png
Diff not rendered.
Binary file removed fern/images/20e2cac-image.png
Diff not rendered.
Binary file removed fern/images/20eb9a4-bored.png
Diff not rendered.
Binary file removed fern/images/2130289-mainnet-deployment-meme.jpeg
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/21819c9-Untitled_28.png
Diff not rendered.
Binary file removed fern/images/21a25eb-small-poetry_discord.jpeg
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/22e9b17-dec.png
Diff not rendered.
Binary file removed fern/images/231792f-terminal-ss.png
Diff not rendered.
Binary file removed fern/images/2331ee9-keystore.png
Diff not rendered.
Binary file removed fern/images/23374cc-mar.png
Diff not rendered.
Binary file removed fern/images/243dfac-alchemy-explorer-sepolia.png
Diff not rendered.
Binary file removed fern/images/245b0a7-image.png
Diff not rendered.
Binary file removed fern/images/24b6259-image.png
Diff not rendered.
Binary file removed fern/images/24d5821-add.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/259cef7-Metamask2_1.PNG
Diff not rendered.
Binary file removed fern/images/25b4197-alchemy_app.png
Diff not rendered.
Binary file removed fern/images/25c65a5-image.png
Diff not rendered.
Binary file removed fern/images/25ffbd7-image.png
Diff not rendered.
Binary file removed fern/images/261c5f7-image.png
Diff not rendered.
Binary file removed fern/images/264c6f4-image.png
Diff not rendered.
Binary file removed fern/images/2655ad8-small-repl_create.jpeg
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/282bd7f-image.png
Diff not rendered.
Binary file removed fern/images/288e705-image.png
Diff not rendered.
Binary file removed fern/images/2a63e7c-image.png
Diff not rendered.
Binary file removed fern/images/2ad0a65-Untitled_12.png
Diff not rendered.
Binary file removed fern/images/2b84459-image.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/2b9fc53-Mumbai.jpeg
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/2bc606d-image.png
Diff not rendered.
Binary file removed fern/images/2bdabe9-image.png
Diff not rendered.
Binary file removed fern/images/2bf06f0-The_chain.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/2e1b46c-image.png
Diff not rendered.
Binary file removed fern/images/2e25baa-Untitled_35.png
Diff not rendered.
Binary file removed fern/images/2e7a9fc-image.png
Diff not rendered.
Binary file removed fern/images/2eb35d6-image.png
Diff not rendered.
Binary file removed fern/images/2ef7f4c-Untitled_43.png
Diff not rendered.
Binary file removed fern/images/2f99400-Image_from_iOS.jpg
Diff not rendered.
Binary file removed fern/images/30229d2-Refract.png
Diff not rendered.
Binary file removed fern/images/3058cb9-image.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/30be1db-paymaster-sponsorship.png
Diff not rendered.
Binary file removed fern/images/30c8a8c-Untitled_17.png
Diff not rendered.
Binary file removed fern/images/311f09a-golden.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/3131641-image.png
Diff not rendered.
Binary file removed fern/images/31fbb3b-localhost.png
Diff not rendered.
Binary file removed fern/images/3247953-SendMatic.png
Diff not rendered.
Binary file removed fern/images/3256828-testnet.png
Diff not rendered.
Binary file removed fern/images/32bd5a2-pasted_image_0.jpg
Diff not rendered.
Binary file removed fern/images/32cafcb-Untitled_2.png
Diff not rendered.
Binary file removed fern/images/32e01d7-PNrbdLnNM6OriGE32N25TGSl.png
Diff not rendered.
Binary file removed fern/images/33e0762-high.jpeg
Diff not rendered.
Binary file removed fern/images/3402e0c-Add_Network_2.png
Diff not rendered.
Binary file removed fern/images/344e465-small-openchain.jpeg
Diff not rendered.
Binary file removed fern/images/34fa087-image.png
Diff not rendered.
Binary file removed fern/images/35eb360-image_64.png
Diff not rendered.
Binary file removed fern/images/3631e0d-small-secret_HIGHLIGHTED.png
Diff not rendered.
Binary file removed fern/images/3676c5b-lawd.png
Diff not rendered.
Binary file removed fern/images/369c066-Untitled_1.png
Diff not rendered.
Diff not rendered.
Binary file removed fern/images/36d2664-Setup_UI.png
Diff not rendered.
Binary file removed fern/images/371860f-Untitled_16.png
Diff not rendered.
Loading
Loading