Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

*.db
*.exe
_build
Expand All @@ -9,5 +8,10 @@ _build
transifex/.env
*.mo

# virtualenv
venv/
# Misc
local/
settings.local.json

# Python
__pycache__/
venv/
67 changes: 67 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# CLAUDE.md

This file provides guidance to Claude Code when working with code in this repository.

## Project Overview

This is the official Dash user documentation repository, built with Sphinx and hosted on Read the Docs at https://docs.dash.org. The documentation covers wallets, masternodes, governance, mining, and developer guides for the Dash cryptocurrency ecosystem.

## Build Commands

```bash
# Set up Python virtual environment (Python 3.13 recommended)
python3.13 -m venv venv/
source ./venv/bin/activate

# Install dependencies
pip install -r requirements.txt

# Build documentation
make html

# Clean rebuild (required when modifying pages)
rm -r _build/ || true && make html
```

The built documentation will be in `_build/html/`. Note: search functionality is not available in local builds.

## Package Management

Uses pip-tools for package management:
```bash
pip install pip-tools

# Add new package: add to requirements.in, then:
pip-compile
pip install -r requirements.txt

# Update all packages:
pip-compile --upgrade
```

## Documentation Structure

* **docs/user/** - User documentation (`.rst` files): wallets, masternodes, governance, mining, developers
* **docs/core/** - Core developer documentation (`.md` files using MyST parser): RPC API reference, protocol guides, P2P network, transaction tutorials, DIPs
* **index.rst** - Main entry point with three-section layout (User Docs, Core Docs, Platform Docs)

The documentation supports both reStructuredText (`.rst`) and Markdown (`.md`) via MyST parser with `colon_fence` extension enabled.

## Key Configuration

* **conf.py** - Sphinx configuration including:
* Theme: `pydata_sphinx_theme`
* Extensions: `myst_parser`, `sphinx_design`, `hoverxref`, `sphinx_copybutton`, `sphinx-sitemap`
* Intersphinx linking to Platform docs at `https://docs.dash.org/projects/platform/en/stable/`
* Auto-clones DIPs repository during build (processed by `scripts/dip-format.sh`)

## Translations

Translations are managed via Transifex. Scripts in `transifex/` handle push/pull operations. Locale files are in `locale/`.

## Helper Scripts

* `scripts/dip-format.sh` - Formats DIPs from the dashpay/dips repository for inclusion in docs
* `scripts/core-download-link-update.sh` - Updates Dash Core download links
* `scripts/evo-tool-download-link-update.sh` - Updates Dash Evo Tool download links
* `scripts/dashmate-update.sh` - Updates dashmate download links content
3 changes: 2 additions & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@
'docs/img/dev/gifs/README.md',
'docs/user/wallets/electrum/dip3_p2sh_howto.md',
'scripts/*',
'venv'
'venv',
'dash-core-src'
]

# The name of the Pygments (syntax highlighting) style to use.
Expand Down
Loading