Skip to content

Commit 4779a79

Browse files
JohnPalmerJohnPalmer
committed
Corrects and improves docs
1 parent a6ec9dd commit 4779a79

File tree

4 files changed

+273
-22
lines changed

4 files changed

+273
-22
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ All datasets use standardized English variable names. Municipality IDs use CUMUN
140140

141141
## License
142142

143-
MIT License - see LICENSE file for details.
143+
GPLv3 License - see LICENSE file for details.
144144
- **Records**: 2,250 station-days
145145
- **Stations**: 838 weather stations
146146
- **Coverage**: 2025-08-17 to 2025-08-25

‎docs/_config.yml‎

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ plugins:
1414
- jekyll-feed
1515
- jekyll-sitemap
1616
- jekyll-seo-tag
17-
- jekyll-paginate
1817

1918
# SEO settings
2019
author: Mosquito Alert
@@ -25,24 +24,10 @@ social:
2524
links:
2625
- https://github.com/Mosquito-Alert
2726

28-
# Navigation
29-
nav_links:
30-
- title: "Home"
31-
url: "/"
32-
- title: "API Analysis"
33-
url: "/api-analysis"
34-
- title: "Data Structure"
35-
url: "/data-structure"
36-
- title: "Scripts Documentation"
37-
url: "/scripts"
38-
- title: "Variable Reference"
39-
url: "/variables"
40-
41-
# Collections
42-
collections:
43-
analysis:
44-
output: true
45-
permalink: /:collection/:name/
27+
# Table of contents
28+
kramdown:
29+
toc_levels: 1..3
30+
auto_ids: true
4631

4732
# Exclude files
4833
exclude:

‎docs/_layouts/toc.html‎

Lines changed: 266 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,266 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
8+
{% seo %}
9+
10+
<link rel="stylesheet" href="{{ '/assets/main.css' | relative_url }}">
11+
<link rel="alternate" type="application/rss+xml" title="{{ site.title | escape }}" href="{{ '/feed.xml' | relative_url }}">
12+
13+
<!-- Custom CSS for sidebar TOC -->
14+
<style>
15+
body {
16+
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
17+
line-height: 1.6;
18+
margin: 0;
19+
padding: 0;
20+
}
21+
22+
.site-header {
23+
border-top: 5px solid #424242;
24+
border-bottom: 1px solid #e8e8e8;
25+
background-color: #fdfdfd;
26+
padding: 15px 0;
27+
}
28+
29+
.header-wrapper {
30+
max-width: 1200px;
31+
margin: 0 auto;
32+
padding: 0 20px;
33+
}
34+
35+
.site-title {
36+
font-size: 26px;
37+
font-weight: 300;
38+
color: #424242;
39+
text-decoration: none;
40+
}
41+
42+
.main-container {
43+
max-width: 1200px;
44+
margin: 0 auto;
45+
padding: 20px;
46+
display: flex;
47+
gap: 30px;
48+
}
49+
50+
.sidebar {
51+
width: 250px;
52+
position: sticky;
53+
top: 20px;
54+
height: fit-content;
55+
background: #f8f9fa;
56+
border: 1px solid #e9ecef;
57+
border-radius: 5px;
58+
padding: 20px;
59+
flex-shrink: 0;
60+
}
61+
62+
.sidebar h3 {
63+
margin-top: 0;
64+
margin-bottom: 15px;
65+
font-size: 18px;
66+
color: #424242;
67+
border-bottom: 2px solid #e9ecef;
68+
padding-bottom: 5px;
69+
}
70+
71+
.toc {
72+
list-style: none;
73+
padding: 0;
74+
margin: 0;
75+
}
76+
77+
.toc li {
78+
margin-bottom: 8px;
79+
}
80+
81+
.toc a {
82+
color: #666;
83+
text-decoration: none;
84+
font-size: 14px;
85+
line-height: 1.4;
86+
display: block;
87+
padding: 4px 0;
88+
border-left: 3px solid transparent;
89+
padding-left: 10px;
90+
}
91+
92+
.toc a:hover {
93+
color: #424242;
94+
border-left-color: #424242;
95+
}
96+
97+
.toc .toc-h2 {
98+
font-weight: 600;
99+
}
100+
101+
.toc .toc-h3 {
102+
padding-left: 20px;
103+
font-size: 13px;
104+
}
105+
106+
.content {
107+
flex: 1;
108+
min-width: 0;
109+
}
110+
111+
.content h1 {
112+
margin-top: 0;
113+
color: #424242;
114+
font-weight: 400;
115+
}
116+
117+
.content h2 {
118+
color: #424242;
119+
margin-top: 40px;
120+
margin-bottom: 15px;
121+
border-bottom: 1px solid #e8e8e8;
122+
padding-bottom: 5px;
123+
}
124+
125+
.content h3 {
126+
color: #424242;
127+
margin-top: 30px;
128+
margin-bottom: 10px;
129+
}
130+
131+
.content table {
132+
border-collapse: collapse;
133+
width: 100%;
134+
margin: 20px 0;
135+
}
136+
137+
.content th,
138+
.content td {
139+
border: 1px solid #e8e8e8;
140+
padding: 8px 12px;
141+
text-align: left;
142+
}
143+
144+
.content th {
145+
background-color: #f8f9fa;
146+
font-weight: 600;
147+
}
148+
149+
.content pre {
150+
background: #f8f9fa;
151+
border: 1px solid #e9ecef;
152+
border-radius: 4px;
153+
padding: 15px;
154+
overflow-x: auto;
155+
font-size: 14px;
156+
}
157+
158+
.content code {
159+
background: #f8f9fa;
160+
padding: 2px 4px;
161+
border-radius: 3px;
162+
font-size: 14px;
163+
}
164+
165+
.content pre code {
166+
background: none;
167+
padding: 0;
168+
}
169+
170+
@media (max-width: 768px) {
171+
.main-container {
172+
flex-direction: column;
173+
padding: 10px;
174+
}
175+
176+
.sidebar {
177+
width: 100%;
178+
position: static;
179+
order: 2;
180+
margin-top: 20px;
181+
}
182+
}
183+
</style>
184+
</head>
185+
186+
<body>
187+
<header class="site-header">
188+
<div class="header-wrapper">
189+
<a class="site-title" href="{{ '/' | relative_url }}">{{ site.title | escape }}</a>
190+
</div>
191+
</header>
192+
193+
<div class="main-container">
194+
<nav class="sidebar">
195+
<h3>Table of Contents</h3>
196+
<ul class="toc">
197+
<li><a href="#system-overview" class="toc-h2">System Overview</a></li>
198+
<li><a href="#data-products" class="toc-h2">Data Products</a>
199+
<ul>
200+
<li><a href="#daily-station-historical-data" class="toc-h3">Daily Station Historical Data</a></li>
201+
<li><a href="#daily-municipal-extended-data" class="toc-h3">Daily Municipal Extended Data</a></li>
202+
<li><a href="#hourly-station-ongoing-data" class="toc-h3">Hourly Station Ongoing Data</a></li>
203+
</ul>
204+
</li>
205+
<li><a href="#data-flow-architecture" class="toc-h2">Data Flow Architecture</a></li>
206+
<li><a href="#technical-implementation" class="toc-h2">Technical Implementation</a>
207+
<ul>
208+
<li><a href="#performance-optimization" class="toc-h3">Performance Optimization</a></li>
209+
<li><a href="#quality-control" class="toc-h3">Quality Control</a></li>
210+
<li><a href="#data-standardization" class="toc-h3">Data Standardization</a></li>
211+
<li><a href="#gap-management" class="toc-h3">Gap Management</a></li>
212+
</ul>
213+
</li>
214+
<li><a href="#installation-and-setup" class="toc-h2">Installation and Setup</a>
215+
<ul>
216+
<li><a href="#prerequisites" class="toc-h3">Prerequisites</a></li>
217+
<li><a href="#configuration" class="toc-h3">Configuration</a></li>
218+
<li><a href="#automation-setup" class="toc-h3">Automation Setup</a></li>
219+
</ul>
220+
</li>
221+
<li><a href="#usage" class="toc-h2">Usage</a>
222+
<ul>
223+
<li><a href="#manual-data-collection" class="toc-h3">Manual Data Collection</a></li>
224+
<li><a href="#monitoring" class="toc-h3">Monitoring</a></li>
225+
</ul>
226+
</li>
227+
<li><a href="#file-organization" class="toc-h2">File Organization</a></li>
228+
<li><a href="#variable-reference" class="toc-h2">Variable Reference</a>
229+
<ul>
230+
<li><a href="#original-aemet-to-standardized-mapping" class="toc-h3">Original AEMET to Standardized Mapping</a></li>
231+
<li><a href="#municipality-code-information" class="toc-h3">Municipality Code Information</a></li>
232+
</ul>
233+
</li>
234+
<li><a href="#performance-metrics" class="toc-h2">Performance Metrics</a>
235+
<ul>
236+
<li><a href="#collection-times" class="toc-h3">Collection Times</a></li>
237+
<li><a href="#data-volumes" class="toc-h3">Data Volumes</a></li>
238+
</ul>
239+
</li>
240+
<li><a href="#support" class="toc-h2">Support</a></li>
241+
<li><a href="#license" class="toc-h2">License</a></li>
242+
</ul>
243+
</nav>
244+
245+
<main class="content">
246+
{{ content }}
247+
</main>
248+
</div>
249+
250+
<!-- Smooth scrolling for anchor links -->
251+
<script>
252+
document.querySelectorAll('a[href^="#"]').forEach(anchor => {
253+
anchor.addEventListener('click', function (e) {
254+
e.preventDefault();
255+
const target = document.querySelector(this.getAttribute('href'));
256+
if (target) {
257+
target.scrollIntoView({
258+
behavior: 'smooth',
259+
block: 'start'
260+
});
261+
}
262+
});
263+
});
264+
</script>
265+
</body>
266+
</html>

‎docs/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Spanish Weather Data Collection System
3-
layout: default
3+
layout: toc
44
---
55

66
# Spanish Weather Data Collection System
@@ -241,7 +241,7 @@ For technical questions or issues:
241241

242242
## License
243243

244-
MIT License - see LICENSE file for complete terms.
244+
GPLv3 License - see LICENSE file for complete terms.
245245
- [Variable Reference](variables.html) - Complete variable definitions
246246

247247
## Recent Updates

0 commit comments

Comments
 (0)