Git Product home page Git Product logo

metaplex-docs's Introduction

docs.metaplex.com

Audience

  • Curious Individuals (technical / non-tech)
  • Non-tech follow directions Buyers/Sellers - How do I use Metaplex
  • Tech - web2 vs web3

Outline

  • ๐Ÿ“ About
    • ๐Ÿ“ Introduction
    • ๐Ÿ“ Metaplex Products
    • ๐Ÿ“ Terminology
    • ๐Ÿ“ History
  • โณ Programs
    • โœ… Understanding Programs
    • โœ… Token Metadata
      • โœ… Overview
      • โœ… Getting Started
      • โœ… Accounts
      • โœ… Instructions
      • โœ… Token Standard
      • โœ… Certified Collections
      • ๐Ÿ“ NFT Escrow (Under Construction)
      • โœ… Using NFTs
      • โœ… FAQ
      • โœ… Changelog / ...
    • ๐Ÿ“ Candy Machine (Needs re-writing using the new Program template)
    • ๐Ÿ“ Auction House (Needs re-writing using the new Program template)
    • โณ Token Vault
    • โณ Gumdrop
    • ๐Ÿ“ Trifle (Under Construction)
  • โณ Tools
    • โณ JavaScript SDK (The new one at metaplex-foundation/js-next)
      • โณ Overview
      • โณ Installation
      • โณ Choosing an Identity
      • โณ Choosing a Storage
      • โณ NFTs
      • โณ Candy Machines
      • โณ Internal Architecture
      • โณ Writing Your Own Plugin
      • โณ Contributing
      • โณ FAQ
    • ๐Ÿ“ Sugar (Needs to be moved inside the "Tools" section and/or guide section)
      • โœ… Overview
      • โœ… Installation
      • โœ… Getting Started
      • โœ… Configurations
      • โœ… Upload Methods
      • โœ… Deploying a Candy Machine
      • โœ… FAQ
    • โณ Shank
    • โณ Solita
    • โณ Amman
  • โณ Guides
    • ๐Ÿ“ Candy Machine
    • ๐Ÿ“ Auction House
    • ๐Ÿ“ Fusion (Under Construction)
    • ๐Ÿ“ NFT hash lists
    • ๐Ÿ“ How to Burn Tokens
    • ๐Ÿ“ NFT Storage Options
    • ๐Ÿ“ Community Guides
    • โณ Archived
      • โœ… Candy Machine (v2) JS CLI
      • โœ… Candy Machine V1
      • โœ… Fair launch
      • โœ… Storefront
      • โœ… Architecture section
  • โณ Proposals
  • โœ… Security Policy
  • ๐Ÿ“ Contact Us

Legend

  • โœ… Completed
  • โณ To-Do
  • ๐Ÿ“ Exists but needs reviewing or rewriting

Program template

  • Overview: Overview of the program. Answers why and what. If possible, provide examples of how one can use the program to create useful scenarios. By the end of this page, the reader should have a good understanding of the program's purpose.
  • Getting Started: Provide resources for developers to start using the program. These resources should be internal when possible, i.e. referring to our "Tools" and/or "Guides" sections.
  • Accounts: List and explain each type of Account and the data they contain.
  • Instructions: List and explain each Instruction and how they update the state of Accounts.
  • [Feature Pages]*: Each program will likely have a need for feature-specific pages, e.g. explaining NFT Collections. Each page should provide an overview of the feature it represents and guide the reader through the accounts and instructions needed to use it.
  • FAQ: Provides the perfect place for us to insert questions we keep answering on various platforms such as Discord. We can also use that page for documenting gotchas. If the answer is long enough to be a guide, it may point to: a page in the "Guide" section, a public Notion page, a GitHub issue, etc.
  • Changelog: Provides a list of major changes that happened in the program.

metaplex-docs's People

Contributors

stegabob avatar samuelvanderwaal avatar lorisleiva avatar austbot avatar marksackerberg avatar aheckmann avatar levicook avatar febo avatar m-sebastiian avatar solsister avatar hectornbl avatar nhanphan avatar adamjeffries avatar stranzhay avatar daeshawnballard avatar c0mberry avatar blockiosaurus avatar kurpav avatar lwus avatar zaxozhu avatar serhiikoziy avatar dtlehrer avatar danenbm avatar doingthisalright avatar jim4067 avatar bslavin avatar adilanchian avatar yusefnapora avatar roederw avatar altar12 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.