Hugging Face's logo

Spaces:
CommunityOne
/
open-navigator
Running on CPU Upgrade

App Files Community
open-navigator
File size: 2,714 Bytes
61d29fc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
---
sidebar_position: 11
---

# 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

### Broken Links

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

```bash
# 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.