Skip to content

mindsend-datatech/snak-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

snaK Documentation Book

This repository contains the official documentation for snaK, a MetaMask Snap integration that enables direct interaction with the Kadena blockchain from within MetaMask.

The book is built using mdBook and covers:

  • What snaK is and how it works
  • Step-by-step user guide for MetaMask integration
  • SDK quickstart for building Snap-compatible dApps
  • Best practices for integration and testing

📚 View the Book

📖 https://mindsend-datatech.github.io/snak-docs/


🛠 Getting Started

Prerequisites

  • Rust
  • mdbook installed (check the official page for instructions)

Running Locally

mdbook serve

This will build and host the book at http://localhost:3000.


📁 Structure

src/
├── intro.md                # General intro to snaK
├── user-guide/             # MetaMask + Snap onboarding flow
├── sdk/                    # Developer quickstart and integration guide
└── SUMMARY.md              # Table of contents

🤝 Contributing

We welcome contributions!

  • Fix typos and broken links
  • Improve clarity or accuracy
  • Add new integration examples or edge case handling

To contribute:

  1. Fork this repository
  2. Make changes in src/
  3. Run mdbook build or mdbook serve to test locally
  4. Open a pull request 🚀

📄 License

Licensed under the Apache License 2.0.

About

User guide for snaK

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •