Skip to content

592 fix workflow errors #595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dbenn merged 2 commits into from
May 7, 2026
Merged

592 fix workflow errors #595

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a61dbc8
#592: extract docs landing page HTML from workflow into separate file
dbenn May 7, 2026
378d728
#592: simplify docs.yml — remove inline HTML template, use static gh-…
dbenn May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
206 changes: 0 additions & 206 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,212 +166,6 @@ jobs:
fi
fi

# Write (or refresh) the docs landing page.
cat > _site/docs/index.html <<'HTML'
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>VStar &mdash; Documentation</title>
<style>
:root {
--bg: #0d1117;
--surface: #161b22;
--border: #30363d;
--text: #e6edf3;
--text-muted: #8b949e;
--accent: #58a6ff;
--header-bg: linear-gradient(135deg, #0d1117 0%, #1a2332 50%, #0d1117 100%);
}

* { margin: 0; padding: 0; box-sizing: border-box; }

body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif;
background: var(--bg);
color: var(--text);
line-height: 1.6;
}

header {
background: var(--header-bg);
border-bottom: 1px solid var(--border);
padding: 2rem 1rem;
text-align: center;
}

header h1 { font-size: 1.5rem; font-weight: 600; letter-spacing: -0.02em; }

header p { color: var(--text-muted); font-size: 0.9rem; margin-top: 0.25rem; }

header .home-link {
display: inline-block;
margin-top: 0.75rem;
font-size: 0.85rem;
color: var(--accent);
text-decoration: none;
}

header .home-link:hover { text-decoration: underline; }

main { max-width: 760px; margin: 0 auto; padding: 2rem 1rem; }

h2.section {
font-size: 0.75rem;
font-weight: 600;
text-transform: uppercase;
letter-spacing: 0.08em;
color: var(--text-muted);
margin: 2rem 0 0.75rem;
}

h2.section:first-child { margin-top: 0; }

.card {
background: var(--surface);
border: 1px solid var(--border);
border-radius: 8px;
padding: 1.25rem 1.5rem;
margin-bottom: 0.75rem;
}

.card h3 { font-size: 1rem; font-weight: 600; margin-bottom: 0.2rem; }

.card .meta { color: var(--text-muted); font-size: 0.8rem; margin-bottom: 0.75rem; }

.links { display: flex; flex-wrap: wrap; gap: 0.5rem; }

.links a {
display: inline-block;
color: var(--accent);
text-decoration: none;
font-size: 0.85rem;
border: 1px solid var(--border);
padding: 0.35rem 0.75rem;
border-radius: 6px;
transition: border-color 0.15s, background 0.15s;
}

.links a:hover { border-color: var(--accent); background: rgba(88,166,255,0.1); }

.note { color: var(--text-muted); font-size: 0.8rem; margin-top: 1.5rem; text-align: center; }

footer {
text-align: center;
padding: 2rem 1rem;
color: var(--text-muted);
font-size: 0.8rem;
border-top: 1px solid var(--border);
}

footer a { color: var(--accent); text-decoration: none; }
footer a:hover { text-decoration: underline; }
</style>
</head>
<body>

<header>
<h1>VStar &mdash; Documentation</h1>
<p>User manual, plugin development guide, and individual plugin docs</p>
<a class="home-link" href="../">&larr; Back to VStar Project Hub</a>
</header>

<main>

<h2 class="section">Snapshot (development)</h2>

<div class="card">
<h3>User Manual</h3>
<div class="meta" id="snapshot-meta">Loading&hellip;</div>
<div class="links">
<a href="vstar/snapshot/user_manual/VStarUserManual.pdf">Open PDF</a>
</div>
</div>

<div class="card">
<h3>Plugin Development Guide</h3>
<div class="links">
<a href="vstar/snapshot/plugin/vstar_plugin_dev.pdf">Open PDF</a>
</div>
</div>

<div class="card">
<h3>Plugin Docs</h3>
<div class="links">
<a href="vstar/snapshot/plugin/">Browse all plugin docs &rarr;</a>
</div>
</div>

<h2 class="section">Latest stable release</h2>

<div class="card">
<h3>User Manual</h3>
<div class="meta" id="release-meta">Loading&hellip;</div>
<div class="links">
<a href="vstar/release/user_manual/VStarUserManual.pdf">Open PDF</a>
</div>
</div>

<div class="card">
<h3>Plugin Development Guide</h3>
<div class="links">
<a href="vstar/release/plugin/vstar_plugin_dev.pdf">Open PDF</a>
</div>
</div>

<div class="card">
<h3>Plugin Docs</h3>
<div class="links">
<a href="vstar/release/plugin/">Browse all plugin docs &rarr;</a>
</div>
</div>

<p class="note">
Snapshot docs track the latest <code>snapshot</code> release tag.
Release docs track the latest semantic-version tag (e.g.&nbsp;<code>X.Y.Z</code>).
Both are refreshed automatically by GitHub Actions.
</p>

</main>

<footer>
<p><a href="https://github.com/AAVSO/VStar">AAVSO/VStar</a> &mdash; Published by the <code>docs</code> workflow.</p>
</footer>

<script>
async function loadMeta() {
try {
const r = await fetch('data/docs.json?_=' + Date.now());
if (!r.ok) throw new Error(r.status);
const d = await r.json();
if (d.snapshot) {
const s = d.snapshot;
document.getElementById('snapshot-meta').textContent =
'Commit ' + (s.commit_short || '') +
(s.commit_date ? ' \u00b7 ' + s.commit_date : '') +
(s.generated ? ' \u00b7 generated ' + s.generated : '');
}
if (d.release) {
const rv = d.release;
document.getElementById('release-meta').textContent =
(rv.tag ? rv.tag + ' \u00b7 ' : '') +
'Commit ' + (rv.commit_short || '') +
(rv.commit_date ? ' \u00b7 ' + rv.commit_date : '') +
(rv.generated ? ' \u00b7 generated ' + rv.generated : '');
}
} catch {
document.getElementById('snapshot-meta').textContent = 'No metadata yet';
document.getElementById('release-meta').textContent = 'No metadata yet';
}
}
loadMeta();
</script>

</body>
</html>
HTML

# Merge new metadata with existing data/docs.json so a snapshot-only or
# release-only run doesn't clobber the other set.
python3 - "$DATE" \
Expand Down
Loading