Tools & Frameworks

Tools & Frameworks

Documentation Platforms

Static Site Generators

  • Docusaurus - Primary choice for most projects
  • Nextra - Next.js-based docs (this site!)
  • GitBook - For collaborative environments
  • MkDocs - Python documentation
  • AsciiDoc/Asciidoctor - Enterprise documentation

CMS & Headless Options

  • Notion (+ Notion API for docs)
  • Contentful
  • Strapi

Writing & Content Tools

Editors

  • VS Code - Primary editor
  • Cursor - AI-enhanced coding
  • Obsidian - Personal knowledge management

Quality & Linting

  • Vale - Prose linting
  • markdownlint - Markdown style checking
  • Grammarly - Grammar and style
  • Hemingway Editor - Readability

Development Tools

Version Control

  • Git - Expert level
  • GitHub - Actions, Pages, collaboration
  • GitLab - CI/CD, documentation hosting

Languages (for reading/documenting)

  • TypeScript/JavaScript
  • Solidity
  • Cairo
  • Python
  • Rust (reading comprehension)

Frameworks (for documentation)

  • React/Next.js - For custom doc sites
  • Tailwind CSS - Styling
  • MDX - Interactive documentation

Infrastructure & DevOps

CI/CD

  • GitHub Actions - Primary CI/CD
  • GitLab CI - Alternative pipelines
  • Vercel - Deployment platform
  • Netlify - Alternative deployment

Containers & Cloud

  • Docker - Containerization
  • AWS - Cloud infrastructure (S3, CloudFront, etc.)

Collaboration & Project Management

Communication

  • Slack - Team communication
  • Discord - Community and dev relations
  • Linear - Issue tracking
  • Notion - Documentation and planning

Design & Assets

  • Figma - Design collaboration
  • Mermaid - Diagram generation
  • Excalidraw - Quick diagrams

Blockchain-Specific Tools

Development Frameworks

  • Hardhat - Ethereum development
  • Foundry - Solidity testing
  • Scarb - Cairo package manager
  • Starknet Devnet - Local testing

Libraries

  • ethers.js / web3.js - Ethereum interaction
  • starknet.js - Starknet interaction

Quick Setup Time

Can be productive within:

  • 1 day: Any Markdown-based system
  • 3 days: Complex custom documentation platforms
  • 1 week: Completely new technical domain

Philosophy: Tools are means to an end. I learn what's needed to deliver excellent documentation.