Skip to content

docs: archive workshop-era docs to docs/archive/#62

Merged
cdhagmann merged 1 commit into
cdhagmann:mainfrom
mvanhorn:osc/45-archive-workshop-docs
May 5, 2026
Merged

docs: archive workshop-era docs to docs/archive/#62
cdhagmann merged 1 commit into
cdhagmann:mainfrom
mvanhorn:osc/45-archive-workshop-docs

Conversation

@mvanhorn

@mvanhorn mvanhorn commented May 5, 2026

Copy link
Copy Markdown
Contributor

Summary

Move docs/workshop.md and docs/prep-plan.md to docs/archive/, update the cross-references that pointed at the old paths, and add a short docs/archive/README.md explaining what's in there.

Linked issue / ADR

Closes #45. No ADR needed; the disposition decision is already documented as Q8 in docs/OPEN_QUESTIONS.md and as the "On the workshop docs" consequence in ADR-0013.

Working agreement

  • Single concern (just the archive move + reference updates + new archive README)
  • bin/rubocop and bin/rspec pass locally (no Ruby touched, docs-only)
  • New behavior has a test; bug fix has a regression test (N/A, docs-only)
  • Async work goes through Rooibos Commands (N/A, docs-only)

Test plan

grep -rE "(^|[^/])workshop\.md|(^|[^/])prep-plan\.md" docs/ --include="*.md" after the move returns only:

  • the link inside the moved files themselves (docs/archive/workshop.md, docs/archive/prep-plan.md)
  • the new docs/archive/README.md pointing at them
  • the OPEN_QUESTIONS.md Q8 decision note, which is the documented decision text and stays unchanged

git diff --stat summary:

docs/adr/0010-charm-ruby-tui-framework.md |  4 ++--
docs/adr/0013-revert-to-rooibos.md        |  2 +-
docs/archive/README.md                    | 18 ++++++++++++++++++
docs/{ => archive}/prep-plan.md           |  0
docs/{ => archive}/workshop.md            |  0
docs/claude-code-prompt.md                |  6 +++---
docs/index.md                             |  2 +-

Notes for reviewer

Two things worth flagging:

  1. docs/workshop-issues/ is listed in the issue scope but does not exist in the working tree (ls docs/ confirms). I left a note in the commit message; happy to follow up if I missed where it lives.
  2. docs/talk/ is untouched per the issue body's explicit exclusion (canonical source for the published GitHub Pages URL).

docs/index.md's workshop attendee paragraph was rewritten from "if you're attending Blue Ridge Ruby 2026" to past-tense referencing the archive, since the workshop has now concluded. If you'd rather drop the paragraph entirely instead of pointing at the archive, easy to amend.

Closes cdhagmann#45.

The Blue Ridge Ruby 2026 workshop concluded 2026-05-02. Move
workshop.md and prep-plan.md to docs/archive/ so they stay preserved
without cluttering the active doc surface. Add docs/archive/README.md
explaining what's there and why.

Cross-references updated:
- docs/index.md: workshop attendee paragraph
- docs/claude-code-prompt.md: three prep-plan.md links
- docs/adr/0010-charm-ruby-tui-framework.md: two workshop.md links
- docs/adr/0013-revert-to-rooibos.md: one workshop.md link

Out of scope per issue body: docs/talk/ stays where it is (canonical
source for the published GitHub Pages URL).

Note: docs/workshop-issues/ was listed in the issue scope but does not
exist in the tree, so no move was performed for it.
@cdhagmann cdhagmann merged commit ac618bd into cdhagmann:main May 5, 2026
2 checks passed
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.

docs: archive workshop-era docs to docs/archive/

2 participants