jamesread af9ed38dff chore: Coderabbit suggestions 1 день назад
..
scripts a26825af1c chore: better screenshots 1 день назад
seed a26825af1c chore: better screenshots 1 день назад
.gitignore a26825af1c chore: better screenshots 1 день назад
Makefile af9ed38dff chore: Coderabbit suggestions 1 день назад
README.md a26825af1c chore: better screenshots 1 день назад
argument-form.png a26825af1c chore: better screenshots 1 день назад
dashboard-dark.png a26825af1c chore: better screenshots 1 день назад
dashboard-mobile.png a26825af1c chore: better screenshots 1 день назад
dashboard.png a26825af1c chore: better screenshots 1 день назад
entities.png a26825af1c chore: better screenshots 1 день назад
execution.png a26825af1c chore: better screenshots 1 день назад
generate-manifest.py a26825af1c chore: better screenshots 1 день назад
logs.png a26825af1c chore: better screenshots 1 день назад
mainpage-darkop.png 7851c5d7d4 docs: Dark mode screenshots 3 месяцев назад
mainpage-darkop_framed.png 7851c5d7d4 docs: Dark mode screenshots 3 месяцев назад
mainpage-laptop.png ea053baf80 docs: Update screenshots in README 3 месяцев назад
mainpage-laptop_framed.png ea053baf80 docs: Update screenshots in README 3 месяцев назад
mainpage-phone.png ea053baf80 docs: Update screenshots in README 3 месяцев назад
mainpage-phone_framed.png ea053baf80 docs: Update screenshots in README 3 месяцев назад
screenshot-manifest.yaml a26825af1c chore: better screenshots 1 день назад
screenshots.ini a26825af1c chore: better screenshots 1 день назад
seed.sh af9ed38dff chore: Coderabbit suggestions 1 день назад

README.md

Marketing screenshots

The screenshots used in the project README, captured from a throwaway OliveTin running the fictional config in seed/.

make screenshots                      # from the repo root
make -C var/marketing/screenshots     # or from anywhere

This builds OliveTin and the webui, starts OliveTin on 127.0.0.1:18337 with a copy of seed/ in tmp/, runs a few actions through the API (seed.sh) so the logs have history, captures every section of screenshots.ini with repo-helper screenshot, regenerates screenshot-manifest.yaml, and then stops OliveTin, even if a step fails.

Requirements

  • Go and Node.js, to build OliveTin and the webui
  • repo-helper, with Chrome and a matching chromedriver
  • curl and jq

No containers are needed: OliveTin keeps its state in config files and memory.

Files

File Purpose
seed/config.yaml, seed/entities/ Fictional config. Commands print static, made-up output, so images never show details of the machine running make.
seed.sh Runs actions with fixed execution tracking ids, so the logs and execution URLs are the same on every run.
screenshots.ini One section per image, plus the title/description/theme used for the manifest.
scripts/ Selenium setup scripts. light.py/dark.py pin prefers-color-scheme, because repo-helper shares one browser session across sections.
generate-manifest.py Writes screenshot-manifest.yaml.
screenshot-manifest.yaml Generated index of the screenshots for indexers. Do not edit by hand.

To add or change a screenshot, edit screenshots.ini and run make. If only a title or description changed, make manifest is enough.

To browse the demo instance yourself, run make build up seed, open http://127.0.0.1:18337/, and run make down when finished.