Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
open_collective: ponyc
33 changes: 33 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Deploy to GitHub Pages

on:
push:
branches: [main]

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: true

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v6.0.2
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: '.'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5
22 changes: 22 additions & 0 deletions .github/workflows/lint-action-workflows.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Lint GitHub Action Workflows

on: pull_request

concurrency:
group: lint-actions-${{ github.ref }}
cancel-in-progress: true

permissions:
packages: read

jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v6.0.2
- name: Check workflow files
uses: docker://ghcr.io/ponylang/shared-docker-ci-actionlint:20260311
with:
args: -color
41 changes: 41 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Reports

This repo hosts reports as static HTML pages served by GitHub Pages. Reports are published on every push to main.

## Adding a report

1. Pick a descriptive slug for your report. The slug should be meaningful on its own without additional context — a reader scanning the directory should understand what the report covers from the slug alone. `stallion-chunked-transfer-encoding` and `ponycheck-shrink-research` are good; `pr-42` and `api-review` are not.

2. Create `r/<slug>/index.html` with your report content. The report is a self-contained HTML file. Different reports may have different visual styles — there is no single required template.

3. Update `r/index.html` to include your report under the appropriate category. Add a list item with a link and a one-line description:

```html
<ul class="report-list">
<li>
<a href="slug/">Report title</a>
<div class="report-desc">One-line description.</div>
</li>
</ul>
```

A report can appear in more than one category. If the category doesn't exist yet, confirm with the user before adding it, then add a new `<section>` for it with an `id`, an `<h2>` heading, and a `<ul class="report-list">`. Add a corresponding nav link in the `<nav>` sidebar.

4. Squash all changes into a single commit and push to main. Each report addition or update should be one commit. The report will be live at `https://ponylang.github.io/reports/r/<slug>/` after the deploy workflow runs.

## Updating a report

Edit the report's `index.html` in place, squash into a single commit, and push. The deploy rebuilds on every push to main.

## Structure

```
r/
index.html # categorized index of all reports
some-report/
index.html # a report
another-report/
index.html # another report
.github/workflows/
deploy.yml # GitHub Pages deployment
```
23 changes: 23 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Copyright (C) 2026 The Pony Developers
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# reports
Hosting for Pony related reports
# Reports

GitHub Pages site for hosting reports generated during Pony development. PR overviews, research documents, code reviews, and other reference material live here as self-contained HTML pages.

Published at https://ponylang.github.io/reports/
11 changes: 11 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="refresh" content="0;url=r/">
<title>Redirecting</title>
</head>
<body>
<p><a href="r/">Reports index</a></p>
</body>
</html>
245 changes: 245 additions & 0 deletions r/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,245 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Pony Reports</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;600&family=Inter:wght@400;500;600;700&display=swap">
<style>
:root {
--bg: #fafaf9;
--fg: #1c1917;
--muted: #78716c;
--accent: #2563eb;
--accent-soft: #dbeafe;
--border: #e7e5e4;
--code-bg: #f5f5f4;
--card-bg: #ffffff;
--nav-bg: #1c1917;
--nav-fg: #d6d3d1;
--nav-active: #60a5fa;
}

@media (prefers-color-scheme: dark) {
:root:not([data-theme="light"]) {
--bg: #0c0a09;
--fg: #e7e5e4;
--muted: #a8a29e;
--accent: #60a5fa;
--accent-soft: #1e3a5f;
--border: #292524;
--code-bg: #1c1917;
--card-bg: #1c1917;
--nav-bg: #0c0a09;
--nav-fg: #a8a29e;
--nav-active: #60a5fa;
color-scheme: dark;
}
}

:root[data-theme="dark"] {
--bg: #0c0a09;
--fg: #e7e5e4;
--muted: #a8a29e;
--accent: #60a5fa;
--accent-soft: #1e3a5f;
--border: #292524;
--code-bg: #1c1917;
--card-bg: #1c1917;
--nav-bg: #0c0a09;
--nav-fg: #a8a29e;
--nav-active: #60a5fa;
color-scheme: dark;
}

body {
background: var(--bg);
color: var(--fg);
font-family: 'Inter', -apple-system, BlinkMacSystemFont, sans-serif;
line-height: 1.6;
margin: 0;
padding: 0;
}

nav {
position: fixed;
top: 0;
left: 0;
width: 220px;
height: 100vh;
background: var(--nav-bg);
color: var(--nav-fg);
padding: 24px 0;
overflow-y: auto;
z-index: 100;
display: flex;
flex-direction: column;
}

nav .site-label {
padding: 0 16px 8px;
font-family: 'IBM Plex Mono', monospace;
font-size: 11px;
color: var(--muted);
text-transform: uppercase;
letter-spacing: 0.06em;
}

nav .site-title {
padding: 0 16px 20px;
font-size: 13px;
font-weight: 600;
border-bottom: 1px solid var(--border);
line-height: 1.4;
}

nav ul { list-style: none; padding: 12px 0; margin: 0; flex: 1; }

nav a {
display: block;
padding: 7px 16px 7px 20px;
color: var(--nav-fg);
text-decoration: none;
font-size: 13px;
transition: background 0.15s, color 0.15s;
position: relative;
}

nav a:hover { background: rgba(255,255,255,0.05); }

nav a.active {
color: var(--nav-active);
background: rgba(96,165,250,0.08);
}

nav a.active::before {
content: '';
position: absolute;
left: 0; top: 4px; bottom: 4px;
width: 3px;
background: var(--nav-active);
border-radius: 0 2px 2px 0;
}

main {
margin-left: 220px;
padding: 32px 48px;
max-width: 860px;
}

section { margin-bottom: 48px; scroll-margin-top: 24px; }

h1 { font-size: 24px; font-weight: 700; margin-bottom: 8px; }
h2 { font-size: 17px; font-weight: 600; margin-bottom: 16px; padding-bottom: 6px; border-bottom: 2px solid var(--accent); display: inline-block; }

.summary-box {
background: var(--accent-soft);
border-left: 4px solid var(--accent);
padding: 14px 18px;
margin-bottom: 20px;
border-radius: 0 6px 6px 0;
font-size: 14px;
}

.report-list { list-style: none; padding: 0; margin: 0; }

.report-list li {
padding: 10px 14px;
border: 1px solid var(--border);
border-radius: 6px;
margin-bottom: 8px;
background: var(--card-bg);
}

.report-list a {
color: var(--accent);
text-decoration: none;
font-weight: 500;
font-size: 14px;
}

.report-list a:hover { text-decoration: underline; }

.report-desc {
font-size: 13px;
color: var(--muted);
margin-top: 4px;
}

.empty-note {
font-size: 13px;
color: var(--muted);
font-style: italic;
}

@media (max-width: 768px) {
nav { position: static; width: 100%; height: auto; padding: 12px 16px; }
nav ul { display: flex; flex-wrap: wrap; gap: 2px; padding: 8px 0; }
nav li { flex: none; }
nav a { padding: 5px 10px; font-size: 12px; border-radius: 4px; }
nav a.active::before { display: none; }
main { margin-left: 0; padding: 16px; }
}
</style>
</head>
<body>

<nav>
<div class="site-label">ponylang</div>
<div class="site-title">Reports</div>
<ul>
<li><a href="#pr-overviews" class="active">PR Overviews</a></li>
</ul>
</nav>

<main>

<section id="about">
<h1>Pony Reports</h1>
<div class="summary-box">
Reports generated during Pony development — PR overviews, research, reviews, and other reference material.
</div>
</section>

<section id="pr-overviews">
<h2>PR Overviews</h2>
<p class="empty-note">No reports yet.</p>
<!--
<ul class="report-list">
<li>
<a href="example-slug/">Report title</a>
<div class="report-desc">One-line description.</div>
</li>
</ul>
-->
</section>

</main>

<script>
const sections = document.querySelectorAll('section[id]');
const navLinks = document.querySelectorAll('nav a[href^="#"]');

const observer = new IntersectionObserver(entries => {
entries.forEach(entry => {
if (entry.isIntersecting) {
navLinks.forEach(a => a.classList.remove('active'));
const link = document.querySelector('nav a[href="#' + entry.target.id + '"]');
if (link) link.classList.add('active');
}
});
}, { rootMargin: '-20% 0px -60% 0px' });

sections.forEach(s => observer.observe(s));

navLinks.forEach(a => {
a.addEventListener('click', e => {
e.preventDefault();
const target = document.querySelector(a.getAttribute('href'));
if (target) target.scrollIntoView({ behavior: 'smooth' });
});
});
</script>

</body>
</html>
Loading