VARASYS/ZDDC-website
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add Publishing and Editing notes to README; stub CLAUDE.md

Browse source 
Captures the rsync-on-push contract (excludes, delete-after) and the
two non-obvious editing constraints (layout.js selector list, inline
<style> convention). CLAUDE.md is now a one-line pointer to README so
/init has something to find.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
ZDDC 2026-05-02 21:27:10 -05:00
parent e3ec3ae93c
commit c275afc4a3
2 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CLAUDE.md Normal file
View file

@ -0,0 +1,3 @@
# CLAUDE.md
See [README.md](README.md).

19
README.md
View file

@ -28,6 +28,25 @@ The preview won't have a `/releases/` directory unless you also have
the source repo and run its build pipeline. That's expected — the
two repos are intentionally decoupled.
## Publishing
`.forgejo/workflows/deploy-content.yml` rsyncs the working tree into
`/srv/zddc/` on the deploy host on every push to `main`. The rsync
uses `--delete-after` and excludes `/releases/`, `/.git*`,
`/.forgejo*`, `/README.md`, and `/LICENSE` — anything else added at
the repo root **will** be published.
## Editing notes
- `js/layout.js` queries the header for `.header-nav`, `.dropdown`,
`.dropdown-toggle`, `.dropdown-menu`, and `.theme-toggle`. Both
HTML pages need to keep those classes or the theme toggle and
Tools dropdown silently break.
- Page-specific CSS goes in an inline `<style>` in `<head>` (see
`index.html`); only shared rules go in `css/style.css`. Design
tokens (`--color-accent`, spacing scale, etc.) live at the top of
`css/style.css` — prefer those over hardcoded values.
## Contributing
Issues + PRs welcome. For changes to the tool source code (not the