website/docs/development/readme-migration.md

---
sidebar_position: 14
---

# README Migration Summary

## ✅ Completed

The README has been restructured to focus on **how to run the code** while moving business content to Docusaurus.

### What Changed

**Old README (~900 lines):**
- Mixed business content with technical setup
- Extensive data source descriptions
- Detailed feature explanations
- Long advocacy and policy sections
- Integration details

**New README (~350 lines):**
- Quick start guide
- Installation options (3 methods)
- Usage examples (CLI, API, Python)
- Basic project structure
- Links to documentation for details

### Business Content Already in Docusaurus

The following sections from the old README are **already documented** in Docusaurus:

| Topic | Docusaurus Location |
|-------|-------------------|
| **Features & Overview** | `website/docs/intro.md` |
| **Architecture** | `website/docs/intro.md` |
| **Nonprofit Data Sources** | `website/docs/data-sources/nonprofit-sources.md` |
| **Census & Jurisdiction Data** | `website/docs/data-sources/census-data.md` |
| **Budget-to-Minutes Analysis** | `website/docs/guides/political-economy.md` |
| **Accountability Strategy** | `website/docs/guides/accountability-strategy.md` |
| **Video Sources** | `website/docs/data-sources/video-sources.md` |
| **Open Source Integrations** | `website/docs/integrations/overview.md` |
| **Deployment Options** | `website/docs/deployment/` directory |
| **HuggingFace Datasets** | `website/docs/data-sources/huggingface-datasets.md` |

## 📋 Content to Potentially Add to Docusaurus

The following sections from the old README could be added if not already covered:

### 1. Policy Topics Monitored

**Old README Content:**
- Water fluoridation initiatives
- School dental screening programs
- Medicaid dental coverage
- Dental clinic funding
- Community dental programs
- Children's dental health

**Suggested Location:** Create `website/docs/guides/policy-topics.md`

### 2. Advocacy Materials Generation

**Old README Content:**
- Personalized emails
- Talking points
- Social media content
- Policy briefs

**Suggested Location:** Create `website/docs/guides/advocacy-materials.md`

### 3. Advocacy Heatmap

**Old README Content:**
- Geographic distribution
- Urgency levels (Critical, High, Medium, Low)
- Topic concentration
- Timeline view

**Suggested Location:** Expand `website/docs/dashboard.md` or create `website/docs/guides/heatmap.md`

### 4. Related Organizations

**Old README Content:**
- GroundVue partnership
- Shared goals
- Government accountability

**Suggested Location:** Create `website/docs/about/partners.md`

## 🎯 New README Structure

```markdown
# Title & Badges
## Documentation Links
## What It Does (brief)
## Architecture (brief)
## Quick Start
  - Prerequisites
  - Installation (3 options)
  - Access Points
## Usage
  - CLI Examples
  - API Examples
  - Python API
## Project Structure
## Deployment Options
## Testing
## Configuration
## Contributing
## Documentation Links
## License & Support
```

## 📚 How to Access Documentation

**Start Documentation Site:**
```bash
cd website
npm start
# Open http://localhost:3000
```

**Documentation Organization:**
- `/docs/intro.md` - Main introduction
- `/docs/data-sources/` - All data source details
- `/docs/guides/` - How-to guides
- `/docs/deployment/` - Deployment options
- `/docs/integrations/` - Integration guides
- `/docs/development/` - Development docs

## 🔄 Next Steps (Optional)

If you want to add the remaining business content to Docusaurus:

1. **Policy Topics:**
   ```bash
   # Create new page
   touch website/docs/guides/policy-topics.md
   ```

2. **Advocacy Materials:**
   ```bash
   touch website/docs/guides/advocacy-materials.md
   ```

3. **Heatmap Details:**
   ```bash
   # Add to existing dashboard.md or create new
   touch website/docs/guides/heatmap.md
   ```

4. **Update Sidebars:**
   Edit `website/sidebars.ts` to add new pages to navigation

## ✨ Benefits

**For Developers:**
- ✅ README is now a quick-start guide
- ✅ Easy to find installation steps
- ✅ Clear usage examples
- ✅ Less scrolling to find technical info

**For Users:**
- ✅ Comprehensive documentation in dedicated site
- ✅ Searchable content
- ✅ Better organization by topic
- ✅ Version-controlled documentation

## 🗑️ Old README Backup

The original README has been saved as `README_OLD.md` for reference.