Skip to content

Repository files navigation

Bitcoin Stamps - Docs

Bitcoin Stamps - Documentation

Official website documentation for the Bitcoin Stamps protocol

 

Live   CI - LEO API Quality Assurance   Deploy to Cloudflare Pages   License: MIT

 


 

📋 Overview

The docs site for Bitcoin Stamps, unprunable data storage on Bitcoin's UTXO set. Built with VitePress and published in 7 languages (en, es, fr, zh, tr, pt, cs). It serves both developers and artists, with automated Schema.org generation for AI discoverability and cultural preservation of community context (yes, KEVIN is detected automatically).

Live site: bitcoinstamps.xyz · Dev preview: dev.bitcoinstamps.xyz

Quick Start

# Install dependencies
npm install

# Start development server
npm run docs:dev

# Build for production
npm run docs:build

# Preview production build
npm run docs:preview

Documentation Structure

  • Guide: introduction and getting started
  • Developers: API reference, SDK docs, and technical specs
  • Artists: creative tutorials and beginner-friendly guides
  • Protocols: SRC-20, SRC-101, SRC-721, SRC-721r, and OLGA specifications
  • Community: contribution guidelines and community resources

Protocol Coverage

Standard What it covers
SRC-20 Fungible tokens, with block 796,000 enhancements
SRC-101 Decentralized naming system
SRC-721 Non-fungible token standard for Stamps
SRC-721r Recursion standard allowing stamps to reference and combine multiple stamps
OLGA P2WSH encoding optimization for all protocols

Bitcoin Art Theme

Custom VitePress theme with Bitcoin-inspired aesthetics:

  • Bitcoin orange (#F7931A) and gold (#FFD700) color scheme
  • Professional typography for both technical and creative content
  • Responsive design supporting developer and artist workflows
  • Dark/light mode with Bitcoin-themed styling

Smart LEO Architecture

Intelligent AI discoverability with minimal maintenance: simple frontmatter plus content produces full Schema.org output, no manual LEO work.

  • Intelligent Schema.org generation: automated entity detection (80% maintenance reduction)
  • Cultural preservation: automatic KEVIN and community context recognition
  • Economic narrative integration: Bitcoin network benefits woven throughout the docs

Key components:

  • <SmartStructuredData />: zero-config automatic Schema.org generation
  • <EntityMention entity="kevin" />: entity linking with cultural enhancement
  • useLEO() composable: content analysis and entity detection

Internationalization

The site ships in 7 languages: English (source), Spanish, French, Chinese, Turkish, Portuguese, and Czech.

Non-English locales (docs/es, docs/fr, docs/zh, docs/tr, ...) can silently fall behind the docs/en source as en is enriched. To surface that drift, CI runs a warn-only freshness gate:

npm run i18n:freshness            # human-readable per-locale drift report
npm run i18n:freshness -- --json  # machine-readable report

For each en page it checks every locale counterpart and classifies it as OK, MISSING, ABRIDGED (materially fewer sections), STALE (abridged and en was git-modified much more recently), or DIVERGENT (a structurally different, usually much larger, tree). Locales are auto-discovered from docs/<loc>/index.md, so new languages are covered automatically. The gate (scripts/check-i18n-freshness.mjs, the i18n-freshness CI job) is non-blocking: translations legitimately lag the source, so it reports drift as a CI ::warning:: plus job summary rather than failing the build.

Contributing

We welcome contributions from both developers and artists.

  1. Branch from main and open a pull request against main (flat workflow, squash merge)
  2. CI must pass before merge (LEO validation, build checks)
  3. Merges to main deploy automatically to Cloudflare Pages

See CONTRIBUTING.md for the full workflow, and the site's contribution guidelines for content standards.

Deployment

Pushes to main trigger the Deploy to Cloudflare Pages workflow, which builds the site and publishes it to production at bitcoinstamps.xyz.

Ecosystem

License

MIT License, see LICENSE for details.

 


Built with Bitcoin 🧡 Permanent by design

About

Official Bitcoin Stamps protocol documentation — bitcoinstamps.xyz

Topics

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages