Skip to content

chore: keep the repository's helpers under docs/ and .github/ - #83

Merged
alukach merged 1 commit into
mainfrom
chore/tidy-helper-dirs
Nov 8, 2026
Merged

alukach merged 1 commit into
mainfrom
chore/tidy-helper-dirs

Conversation

@alukach

@alukach alukach commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

Moves the repository's helper folders out of the top level. This changes nothing a user of the CLI sees: no commands, no output, no guide pages.

What moved

demo/                        →  docs/recorder/
  README.md, record.py,          README.md, record.py, stub.py,
  stub.py, check_stub.py,        check_stub.py, fixtures.json,
  fixtures.json                  guide.py
  demos/guide.py
preview/install.sh           →  .github/preview/install.sh

The top level goes from three helper folders (demo/, docs/, preview/) to one, docs/:

  • docs/recorder/. The recorder only produces docs/demos/, so it lives beside it. guide.py, the one kept demo script, moves up from its own demos/ folder. The git-ignored casts/ and scripts/ follow it (.gitignore updated).
  • .github/preview/install.sh. Only the Preview build workflow uses it: it checks out just that file, sets the preview's name in it and attaches it to the pre-release. Putting it in .github/ also ends a clash between two meanings of "preview": preview builds of the CLI, and the docs' PR previews (pr-preview/pr-N/).
  • What stays put. docs/site/ and docs/demos/ don't move. The README's images link to docs/demos/*.svg, and the Docs workflow republishes a release by running docs/site/build.py from that release's tag, so moving it would break republishing older versions.

Follow-on changes

  • Path references: about 55, in AGENTS.md, CONTRIBUTING.md, the recorder's README and scripts, docs/site/assets/player.js (a comment), and the Stub matches the API and Preview build workflows (path filters, run:, checkout and sed).
  • Docs workflow: now ignores docs/recorder/**, so a change only to the recorder builds no docs preview. That's how it behaved when the recorder sat outside docs/.
  • AGENTS.md: now names the one kept script, docs/recorder/guide.py, where it used to name a demos/ folder.

Testing

  • uv run --with jsonschema python docs/recorder/check_stub.py: every route ok against staging's spec.
  • python3 -I docs/recorder/record.py docs/recorder/guide.py tour: recorded into docs/recorder/casts/, the new default output folder, which git ignores.
  • uv run --with markdown-it-py python docs/site/build.py --out target/site: 15 pages and 31 demos, as before.
  • cargo test: 165 passed. All three edited workflows parse as YAML.
  • Not tried: the Preview build workflow's publish path, which runs only on main. This PR exercises its build-only path, since it changes .github/preview/install.sh.

🤖 Generated with Claude Code

github-actions Bot added a commit that referenced this pull request Nov 8, 2026
@claude

claude Bot commented Nov 8, 2026 •

Copy link
Copy Markdown

Claude finished @alukach's task in 11s —— View job


I'll analyze this and get back to you.


💰 Estimated review cost: $0.15 · 0m10s · 3 turns

@github-actions

github-actions Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

Docs preview: https://source-cooperative.github.io/source-coop-cli/pr-preview/pr-83/

Built from baef685. It goes live a minute or two after the Docs deploy run, and is removed when the PR closes.

@alukach
alukach force-pushed the chore/tidy-helper-dirs branch from 337b406 to b856328 Compare November 8, 2026 04:18
github-actions Bot added a commit that referenced this pull request Nov 8, 2026
Base automatically changed from docs/demos-throughout to main November 8, 2026 04:31
demo/, docs/ and preview/ were three top-level folders of helpers. The
demo recorder only produces docs/demos/, so it moves beside it as
docs/recorder/, with its one kept script, guide.py, at its top. The
preview installer is only used by the Preview build workflow, so it moves
to .github/preview/. docs/site/ and docs/demos/ stay put: the README links
the recordings there, and republishing a release runs docs/site/build.py
from that release's tag.

The Docs workflow skips docs/recorder/, so changing only the recorder
builds no docs preview, as before.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@alukach
alukach force-pushed the chore/tidy-helper-dirs branch from b856328 to baef685 Compare November 8, 2026 04:35
github-actions Bot added a commit that referenced this pull request Nov 8, 2026
@alukach
alukach merged commit 01429d0 into main Nov 8, 2026
19 checks passed
@alukach
alukach deleted the chore/tidy-helper-dirs branch November 8, 2026 05:00
github-actions Bot added a commit that referenced this pull request Nov 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant