Copyright Compendium Documentation

Welcome to the documentation for the Copyright Compendium web display project.

Overview

This repository contains a simple web display for the U.S. Copyright Office's Copyright Compendium. The Compendium is available as a PDF on Copyright.gov, but is difficult to navigate. This project provides a navigable and searchable web version.

Technology Stack

• Frontend: TypeScript with Vite build system
• UI Framework: USWDS (U.S. Web Design System) components
• Search: Algolia search with autocomplete
• Testing: Vitest with comprehensive unit and integration tests
• Type Checking: TypeScript with strict mode enabled

Documentation Sections

Quality Assurance

• QA Overview - Quality assurance methodology and tools
• Testing - Automated content checking QA engine
• UI Testing - Frontend testing with Vitest
• Translation Testing - Translation feature testing
• PDF Text Tests - PDF to HTML text comparison tests
• PDF to HTML Comparison - Comparison methodology

Features

• Disclaimer Banner - Prototype vs Generic Gov banner
• Translation Feature - Browser-based translation overview
• Translation Implementation - Implementation guide
• Translation Fix Summary - Recent fixes and updates

Reports

• Broken Links Report - Link validation report
• Audit Summary - Comprehensive audit results

Quick Links

• Main Repository README
• Live Site
• GitHub Repository

Getting Started

For information on running the project locally, building, and deploying, please refer to the main README.md in the repository root.