Skip to content

docs: describe the finished roadmap and add community files - #105

Merged
Wahbeh-Mohammad merged 2 commits into
mainfrom
docs-post-roadmap-refresh
Sep 26, 2026
Merged

Wahbeh-Mohammad merged 2 commits into
mainfrom
docs-post-roadmap-refresh

Conversation

@Wahbeh-Mohammad

Copy link
Copy Markdown
Contributor

What and why

All eleven roadmap phases (0–10) are merged, and every gem is still at 0.0.0 and unpublished. The root README, CLAUDE.md's opening and the community files still read as if the project were mid-build. Every claim below was re-derived from the tree (file counts, gate list, checklists, gemspecs), not copied from existing prose.

  • README.md: a short pre-release status instead of the ~60-line phase-by-phase inventory. It has one row per gem (what the gem carries, its runtime dependencies), the supported Rubies (3.2–4.0, with async_http needing 3.3+) and the twenty-four gates, and it points at docs/first-release.md.
  • CLAUDE.md: the ~240-line opening inventory is now a table with one row per gem and per layer, pointing at the as-built page and the checklists. The next step is named as the release path in docs/first-release.md. The stale (planned) markers are gone, and so is the "every checklist but … is still to be written" sentence. The phase workflow now says how post-v1 work follows it. The "Constraints that will bite", the command block and the probe-read claim sentences are unchanged in substance, and nothing about the frozen-chapter amendments or docs/deviations.md was touched. Net −250 lines.
  • docs/README.md: knowledge/harvested/ and knowledge/notes/ exist, so their (planned) markers are dropped and the entries are linked.
  • gems/dexpace-core/README.md: it now names the 8b and 8c adapter gems and drops "the adapter phase 8 ships". The other five gem READMEs were already accurate.
  • CONTRIBUTING.md: it was written before gems/ existed. It now covers the real setup, the 24 gates, the Ruby range, the spec-driven contribution flow and the PR expectations.
  • SECURITY.md: the "once it exists" wording is gone, and the in-scope list is concrete. The reporting channel is unchanged.
  • .github/: bug-report and feature/requirement issue forms (they use the repository's type:bug / type:feature labels), config.yml (blank issues off, plus links to SECURITY.md and first-release.md), pull_request_template.md (requirement IDs, gates run, ledger and first-release records) and CODEOWNERS (@Wahbeh-Mohammad). The sibling nodejs-sdk has none of these to mirror. By the repository's convention, Markdown and YAML files carry no SPDX header.

Requirements

None. This is documentation only.

Verification

  • bundle exec rake, all twenty-four gates, green on Ruby 4.0.6 (the .ruby-version development Ruby)
  • ruby .claude/skills/housekeeping/probe.rb exits 0 before and after (nine checks)
  • The issue forms parse as YAML

Note: on Ruby 3.4.10, test:gates' RequireAllowlistTest "rejects tsort … bundled at 4.1" fails locally, because 3.4's Gem::BUNDLED_GEMS::SINCE has no tsort entry. CI runs that gate on 4.0 only, so this is not a regression and has nothing to do with this change.

All eleven roadmap phases are merged and nothing is published, but
the root README, CLAUDE.md's opening and the community files still
read as a project mid-build. Re-derived from the tree:

- README.md: a short pre-release status, one row per gem, the
  supported Rubies and the twenty-four gates, in place of the
  phase-by-phase inventory.
- CLAUDE.md: the opening inventory becomes a per-gem, per-layer
  table pointing at the as-built pages and checklists; the next
  step is named as docs/first-release.md's release path; the stale
  "(planned)" markers and the checklist sentence are corrected, and
  the phase workflow says how post-v1 work follows it.
- docs/README.md: the two knowledge entries exist; drop "(planned)".
- dexpace-core's README: the adapter gems 8b and 8c shipped.
- CONTRIBUTING.md and SECURITY.md: the gates, the Ruby range with
  async_http's 3.3 floor, the spec-driven contribution flow, and a
  concrete in-scope list for vulnerability reports.
- .github: bug and feature/requirement issue forms, config.yml,
  a pull request template and CODEOWNERS.
Six sentences went stale when #106 applied the frozen-chapter amendments
and consolidated the phase ledgers into design §10: the construction
bullet now names Pipeline::Entry as the one model that validates in
.build alone (C19); the interrupt ban covers code this repository
writes, not its dependencies (C8); the deadline bullet counts two unmet
MUSTs and one vacuous, and names the three MUST clauses §10.20-§10.22
now admit; the decode-boundary bullet says C1 corrected §3.1; and the
phase-10 paragraph records that the maintainer applied C1-C25 and that
§10 carries 38 entries matched by docs/deviations.md.
@Wahbeh-Mohammad
Wahbeh-Mohammad force-pushed the docs-post-roadmap-refresh branch from 81e1eee to 2a46f06 Compare September 26, 2026 05:53
@Wahbeh-Mohammad
Wahbeh-Mohammad merged commit 140475d into main Sep 26, 2026
5 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.

1 participant