feat: searchable prompt store (GitHub Pages) + README split #1

Merged
ron merged 4 commits from feat/prompt-site-and-docs into main 2026-10-16 07:06:30 +00:00
Owner

What this adds

A user-facing prompt store — a static, searchable site published to
https://prompts.ronzz.org from the GitHub push mirror — plus a README split so
the repository is approachable for non-technical teammates.

Docs split

  • README.md — short, non-technical intro with pointers.
  • USERGUIDE.md — end-user guide (Veramiko, opencode, copy-paste, fill-in markers).
  • CONTRIBUTING.md — technical guide: layout, {{include:}}, system-prompt
    frontmatter, filenames-as-commands, build, Open WebUI sync + its CI
    constraints, and the prompt-store pipeline.

Prompt store (site/, Astro)

  • Home: “Ronzz.org central prompt store”, centred search, tiles for the
    user guide and the theme tree.
  • /userguide and /contributing rendered from the root markdown.
  • /themes — tree of every prompt (12 groups, 42 prompts + 2 models).
  • /prompts/<path> — each prompt with a Copy button that yields exactly the
    text Open WebUI receives (generated header + YAML frontmatter stripped, same
    normalisation as sync-owui.py).
  • Build-time full-text search index (search-index.json) with a client-side filter.

Deployment

  • .github/workflows/pages.yml rebuilds dist/, builds the site, and deploys
    _site/ via actions/deploy-pages.
  • Custom domain prompts.ronzz.org (site/public/CNAME + Pages settings).

Verification

  • python3 build-prompts.py --check → dist/ up to date.
  • Local npm run build → 46 pages; Chromium smoke test of the home search, the
    theme tree, and the copy button → all pass, no console errors.

DNS still to add (Cloudflare)

CNAME prompts → ron-ronzz-org.github.io, grey cloud (DNS only) so GitHub can
issue its own TLS certificate. See RonzzIT:Runbook/Cloudflare.

## What this adds A **user-facing prompt store** — a static, searchable site published to <https://prompts.ronzz.org> from the GitHub push mirror — plus a README split so the repository is approachable for non-technical teammates. ### Docs split - `README.md` — short, non-technical intro with pointers. - `USERGUIDE.md` — end-user guide (Veramiko, opencode, copy-paste, fill-in markers). - `CONTRIBUTING.md` — technical guide: layout, `{{include:}}`, system-prompt frontmatter, filenames-as-commands, build, Open WebUI sync + its CI constraints, and the prompt-store pipeline. ### Prompt store (`site/`, Astro) - Home: **“Ronzz.org central prompt store”**, centred search, tiles for the user guide and the theme tree. - `/userguide` and `/contributing` rendered from the root markdown. - `/themes` — tree of every prompt (12 groups, 42 prompts + 2 models). - `/prompts/<path>` — each prompt with a **Copy** button that yields exactly the text Open WebUI receives (generated header + YAML frontmatter stripped, same normalisation as `sync-owui.py`). - Build-time full-text search index (`search-index.json`) with a client-side filter. ### Deployment - `.github/workflows/pages.yml` rebuilds `dist/`, builds the site, and deploys `_site/` via `actions/deploy-pages`. - Custom domain `prompts.ronzz.org` (`site/public/CNAME` + Pages settings). ### Verification - `python3 build-prompts.py --check` → `dist/` up to date. - Local `npm run build` → 46 pages; Chromium smoke test of the home search, the theme tree, and the copy button → all pass, no console errors. ### DNS still to add (Cloudflare) `CNAME prompts → ron-ronzz-org.github.io`, grey cloud (DNS only) so GitHub can issue its own TLS certificate. See `RonzzIT:Runbook/Cloudflare`.
Root README.md is now a short, non-technical introduction. The new
USERGUIDE.md explains how to use the prompts (Open WebUI, copy-paste,
fill-in markers) for non-technical users; CONTRIBUTING.md holds the
technical details (layout, {{include:}} directives, build, opencode
config, Open WebUI sync and its CI constraints, filenames-as-commands).
A non-technical visitor can now browse, search, and copy every prompt
without touching the repository.

- site/: Astro project. scripts/prepare-content.mjs reads dist/*.prompt.md
  (plus USERGUIDE.md and CONTRIBUTING.md), strips the generated header and
  YAML frontmatter the same way sync-owui.py does, and emits
  src/data/*.json + a client-side search-index.json.
- Pages: home (title, centred search, tiles), /userguide, /contributing,
  /themes (tree of every prompt), and /prompts/<path> with a Copy button
  that yields exactly the text Open WebUI receives.
- .github/workflows/pages.yml rebuilds dist/, builds the site, and deploys
  _site/ via actions/deploy-pages (build-only on pull requests).
- Document the site in CONTRIBUTING.md and AGENTS.md.
Merge origin/main into feat/prompt-site-and-docs
Some checks failed
Deploy prompt store / build (pull_request) Has been cancelled
Deploy prompt store / deploy (pull_request) Has been cancelled
386b639eb9
main had gained a technical "Prompt hub: adding prompts and models" section
appended to the pre-split README. Post-split that content belongs in
CONTRIBUTING.md, so relocate it there (deployment wiki link, the
.secrets/owui-api-key dry-run, delete-by-deleting-source, the
do-not-create-by-hand warning, Open WebUI {{variable}} placeholders) and keep
README short.

Point the prompt store at the custom domain prompts.ronzz.org (astro.config.mjs,
site/public/CNAME, docs) and fix the user guide's broken sentence and dead
anchor.
ron merged commit 84dcc475aa into main 2026-10-16 07:06:30 +00:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
ronzz-org/ronzz-LLM-prompt-hub!1
No description provided.