docs-to-pdf: Instructions file for Claude Code

Claude Development Guide for docs-to-pdf

This document provides specific guidance for AI assistants (particularly Claude) when working on the docs-to-pdf project.

Project Overview

docs-to-pdf is a TypeScript-based tool that generates PDFs from documentation websites (like Docusaurus). It uses Puppeteer to crawl pages, combine them into a single HTML document, and generate a PDF.

Development Environment Setup

Using mise (Recommended)

This project uses mise to manage the Node.js version:

# Install mise (if not already installed)
# See: https://mise.jit.su/getting-started.html

# Initialize the project - this will:
# - Read mise.toml
# - Install the specified Node.js version
# - Set it up for this project
mise install

# Verify Node.js version
node --version  # Should match version in mise.toml

The mise.toml file in the project root defines:

• Required Node.js version
• Any other development tool versions

Manual Setup

If not using mise:

# Ensure Node.js >= 20.0.0 is installed
yarn install
yarn build

Pre-Commit Checklist

Before committing ANY changes, you MUST:

1. Run Tests

yarn test

Result: All tests must pass. If any test fails, fix the issue before committing.

2. Run Linter

yarn lint

Result: No linting errors. Fix any issues with:

yarn lint:fix

3. Build TypeScript

yarn build

Result: TypeScript must compile without errors. The lib/ directory will be generated.

4. Docker Tests (if modifying Docker files)

If you modified any Docker-related files:

cd docker
./test-quick.sh

Result: At least the quick tests should pass.

Commit Message Requirements

DO NOT Update CHANGELOG.md Manually

This project uses release-please to:

• Automatically generate CHANGELOG.md
• Bump version numbers
• Create releases
• Trigger npm/Docker publishing