Skip to main content

Documentation Migration Summary

✅ Successfully Migrated 40+ Documentation Files​

All markdown documentation from the docs/ directory has been organized and migrated to the Docusaurus documentation site at website/docs/.

Organization Structure​

📊 Data Sources (website/docs/data-sources/)​

  • Overview of all data sources
  • Jurisdiction Discovery (Census Bureau, 90K+ jurisdictions)
  • Census Data integration
  • Civic Tech URL sources
  • URL datasets (confirmed and analyzed)
  • HuggingFace datasets
  • Video sources (YouTube, channels)
  • Video discovery improvements

🔌 Integrations (website/docs/integrations/)​

  • Integration overview
  • Frontend integration guide
  • Dataverse integration (Harvard academic datasets)
  • LocalView integration (1,000+ municipalities)
  • eBoard automated solutions
  • eBoard cookie management
  • eBoard manual download guides

📚 Guides (website/docs/guides/)​

  • Jurisdiction setup
  • Accountability strategy
  • Impact navigation
  • Political economy analysis
  • Handling multiple formats
  • Document libraries
  • Scraper improvements
  • Search patterns
  • Split-screen system
  • HuggingFace subsection:
    • Features summary
    • File limits
    • Publishing guide
    • Quick start

🚀 Deployment (website/docs/deployment/)​

  • Jurisdiction discovery deployment
  • Running at scale
  • Cost breakdown
  • Cost-effective storage strategies

💻 Development (website/docs/development/)​

  • Changelog (Discovery V2)
  • Migration summary (V2)
  • New capabilities
  • Enhancements to official sources
  • Integration status

Access the Documentation​

URL: http://localhost:3000

The documentation site is now running with:

  • ✅ Organized sidebar navigation
  • ✅ All 40+ markdown files migrated
  • ✅ Searchable content
  • ✅ Dark mode support
  • ✅ Mobile-friendly design

Some internal links in the migrated docs reference old filenames (e.g., JURISDICTION_DISCOVERY.md). These warnings are shown during build but don't break the site. They can be fixed by updating the markdown files to use the new paths.

Original Files​

The original docs/ directory still exists with all the original markdown files. Once you verify the migration is complete, you can optionally remove or archive it.

Commands​

# Start documentation site
cd website && npm start

# Start all services (includes docs)
./start-all.sh

# Stop all services
./stop-all.sh

What's Next​

The documentation link in the React dashboard header now works correctly and opens the comprehensive documentation site with all your guides, integrations, data source information, and deployment guides.