Repository navigation
chore: keep the repository's helpers under docs/ and .github/ - #83
Merged
Merged
Conversation
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
force-pushed
the
chore/tidy-helper-dirs
branch
from
November 8, 2026 04:18
337b406 to
b856328
Compare
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
force-pushed
the
chore/tidy-helper-dirs
branch
from
November 8, 2026 04:35
b856328 to
baef685
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
The top level goes from three helper folders (
demo/,docs/,preview/) to one,docs/:docs/recorder/. The recorder only producesdocs/demos/, so it lives beside it.guide.py, the one kept demo script, moves up from its owndemos/folder. The git-ignoredcasts/andscripts/follow it (.gitignoreupdated)..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/).docs/site/anddocs/demos/don't move. The README's images link todocs/demos/*.svg, and the Docs workflow republishes a release by runningdocs/site/build.pyfrom that release's tag, so moving it would break republishing older versions.Follow-on changes
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 andsed).docs/recorder/**, so a change only to the recorder builds no docs preview. That's how it behaved when the recorder sat outsidedocs/.docs/recorder/guide.py, where it used to name ademos/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 intodocs/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.main. This PR exercises its build-only path, since it changes.github/preview/install.sh.🤖 Generated with Claude Code