Skip to content
This repository has been archived by the owner on Jan 23, 2024. It is now read-only.

Latest commit

 

History

History
89 lines (81 loc) · 3.24 KB

README.md

File metadata and controls

89 lines (81 loc) · 3.24 KB
Raw

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.