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
20 changes: 20 additions & 0 deletions .github/workflows/site-checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Site checks

on:
pull_request:
push:
branches: [master]

permissions:
contents: read

jobs:
verify:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Check landing page structure and links
run: python3 scripts/check_site.py
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# NILMTK ecosystem site

This repository publishes the canonical NILMTK ecosystem router at
<https://nilmtk.github.io/>. It explains which repository to use, the supported
installation paths, the container policy, citation guidance, and the route from
a model contribution to a leaderboard result.

The site is deliberately dependency-free: semantic HTML, one stylesheet, and a
small progressive-enhancement script. Existing generated core API documentation
under `nilmtk/` remains separate from the landing page.

## Preview

```bash
python3 -m http.server 8000
```

Then open <http://localhost:8000/>.

## Verify

```bash
python3 scripts/check_site.py
```

The check rejects duplicate IDs, broken local assets and fragment links,
insecure public URLs, missing canonical repository or citation links, and
accidental reintroduction of the retired Bootstrap/jQuery stack.

## Editing policy

- Keep this page a router; detailed package APIs belong in their repositories.
- Keep one recommended Python path and one general onboarding image.
- Treat NILMbench's CPU and CUDA images as scientific runtimes, not per-model
development images.
- Update citation guidance only when the canonical repository papers change.
- Verify commands against the target repository before publishing them here.
Loading
Loading