Skip to content

Official documentation for Raven House - A privacy-focused NFT marketplace built on Aztec Network. Guides, tutorials, and API references for creating, managing, and trading private NFTs.

License

Notifications You must be signed in to change notification settings

satyambnsal/docs.ravenhouse

Repository files navigation

Raven House Documentation

This repository contains the official documentation for Raven House, a privacy-focused NFT marketplace built on Aztec Network.

About Raven House

Raven House is a next-generation NFT marketplace that leverages Aztec Network's zero-knowledge technology to provide enhanced privacy, lower fees, and improved user experience for creators and collectors.

Documentation

This documentation is built using Nextra, a Next.js-based documentation framework.

Features

  • Comprehensive guides for using Raven House
  • Privacy and security explanations

Running Locally

To run the documentation site locally:

  1. Clone this repository

    git clone https://github.com/satyambnsal/docs.ravenhouse.git
    cd docs.ravenhouse
    
  2. Install dependencies

    npm install
    # or
    yarn
    
  3. Start the development server

    npm run dev
    # or
    yarn dev
    
  4. Open http://localhost:3000 in your browser

Structure

  • pages/ - Documentation content (MDX files)
  • public/ - Static assets (images, etc.)
  • theme.config.tsx - Nextra theme configuration

Contributing

We welcome contributions to improve our documentation!

  1. Fork this repository
  2. Create a new branch for your changes
  3. Make your changes
  4. Submit a pull request

Please ensure your contributions are accurate and follow our documentation style guide.

Deployment

This documentation is automatically deployed using Vercel on changes to the main branch.

License

This repository is licensed under the MIT License - see the LICENSE file for details.

Contact

For questions about the documentation or Raven House in general:

About

Official documentation for Raven House - A privacy-focused NFT marketplace built on Aztec Network. Guides, tutorials, and API references for creating, managing, and trading private NFTs.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published