project-transfer: renaming project and owning org#56
Conversation
…us on pattern data and ops, with serialization to gram as secondary
There was a problem hiding this comment.
Pull request overview
This PR standardizes the repository’s documentation and related artifacts to reflect the rename from gram-hs to pattern-hs, including updates to canonical JSON alignment/decision docs and schema metadata references.
Changes:
- Renamed project references across specs, docs, design notes, and helper scripts (
gram-hs→pattern-hs). - Updated canonical JSON documentation and generated-type headers to match the new project name.
- Updated the JSON Schema
$idURL to the new GitHub Pages path.
Reviewed changes
Copilot reviewed 29 out of 29 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| specs/030-separate-container-content-parsing/research.md | Rename references in research notes for container/content parsing. |
| specs/030-separate-container-content-parsing/quickstart.md | Update quickstart wording to the new project name. |
| specs/030-separate-container-content-parsing/plan.md | Update plan summary to reference pattern-hs. |
| specs/029-canonical-json-pattern/spec.md | Update porting user story to reference pattern-hs. |
| specs/029-canonical-json-pattern/quickstart.md | Update GitHub issues link to the renamed repo. |
| specs/029-canonical-json-pattern/contracts/typescript-types.ts | Update generated-from header; minor formatting change in a function signature. |
| specs/029-canonical-json-pattern/contracts/rust-types.rs | Update generated-from header to pattern-hs. |
| specs/027-docs-reorganization/spec.md | Rename project references in documentation reorg spec. |
| specs/025-decouple-identity-assignment/tasks.md | Update spec frontmatter description to pattern-hs. |
| specs/024-codefence-strings/plan.md | Update plan metadata to reference pattern-hs. |
| specs/022-documentation-reorganization/spec.md | Rename gram-hs references across doc reorg user stories/requirements. |
| specs/022-cli-improvements/spec.md | Update porting stories and design doc pointer for CLI improvements. |
| specs/020-subject-serialization/tasks.md | Update spec frontmatter description to pattern-hs. |
| specs/019-integration-polish/data-model.md | Update public API surface description to pattern-hs. |
| specs/017-gram-serializer-updates/plan.md | Update plan metadata to reference pattern-hs monorepo. |
| scripts/init-submodules.sh | Update script banner output to pattern-hs. |
| scripts/ci-check.sh | Update script banner output to pattern-hs. |
| scripts/README.md | Update example paths/output to pattern-hs. |
| proposals/pattern-reconciliation.md | Rename proposal references to pattern-hs. |
| libs/gram/src/Gram/Schema/TypeScript.hs | Update generated TS header to pattern-hs. |
| libs/gram/src/Gram/Schema/Rust.hs | Update generated Rust header to pattern-hs. |
| libs/gram/src/Gram/Schema/JSONSchema.hs | Update schema $id URL to pattern-hs GitHub Pages path. |
| docs/reference/PORTING-GUIDE.md | Rename project references and CLI section wording for pattern-hs. |
| docs/reference/CANONICAL-JSON-ALIGNMENT.md | Rename canonical alignment doc references to pattern-hs. |
| design/gram-hs-cli-plan.md | Update implementation/reference paths to apps/gramref-cli/. |
| design/gram-hs-cli-improvements.md | Rename test-directory references to pattern-hs. |
| README.md | Update structure/example references to pattern-hs and gramref-cli. |
| JSON-SCHEMA-DECISION.md | Rename decision analysis framing to pattern-hs. |
| .github/copilot-instructions.md | Update Copilot instructions header and structure references to pattern-hs. |
| - **pattern-hs JSON Schema**: `../pattern-hs/specs/029-canonical-json-pattern/contracts/json-schema.json` | ||
| - **pattern-hs Spec**: `../pattern-hs/specs/029-canonical-json-pattern/spec.md` | ||
| - **pattern-hs Data Model**: `../pattern-hs/specs/029-canonical-json-pattern/data-model.md` | ||
| - **pattern-hs TypeScript Types**: `../pattern-hs/specs/029-canonical-json-pattern/contracts/typescript-types.ts` |
There was a problem hiding this comment.
These reference links point to ../pattern-hs/specs/..., but there is no docs/pattern-hs/ directory in this repo, so the paths are broken. Consider using correct in-repo relative paths (e.g., ../../specs/...) or absolute GitHub URLs.
| - **pattern-hs JSON Schema**: `../pattern-hs/specs/029-canonical-json-pattern/contracts/json-schema.json` | |
| - **pattern-hs Spec**: `../pattern-hs/specs/029-canonical-json-pattern/spec.md` | |
| - **pattern-hs Data Model**: `../pattern-hs/specs/029-canonical-json-pattern/data-model.md` | |
| - **pattern-hs TypeScript Types**: `../pattern-hs/specs/029-canonical-json-pattern/contracts/typescript-types.ts` | |
| - **pattern-hs JSON Schema**: `../../specs/029-canonical-json-pattern/contracts/json-schema.json` | |
| - **pattern-hs Spec**: `../../specs/029-canonical-json-pattern/spec.md` | |
| - **pattern-hs Data Model**: `../../specs/029-canonical-json-pattern/data-model.md` | |
| - **pattern-hs TypeScript Types**: `../../specs/029-canonical-json-pattern/contracts/typescript-types.ts` |
| **Verdict**: ✅ **gram-rs approach is superior - use `identity`** | ||
|
|
||
| **Action**: gram-hs should change `symbol` → `identity` (see GRAM-HS-JSON-ALIGNMENT.todo.md) | ||
| **Action**: pattern-hs should change `symbol` → `identity` (see pattern-hs-JSON-ALIGNMENT.todo.md) |
There was a problem hiding this comment.
This references pattern-hs-JSON-ALIGNMENT.todo.md, but that file does not exist in the repository root. Either add the referenced TODO file, or update the link to point at an existing tracking document (e.g., TODO.md) so readers aren’t sent to a dead reference.
| **Action**: pattern-hs should change `symbol` → `identity` (see pattern-hs-JSON-ALIGNMENT.todo.md) | |
| **Action**: pattern-hs should change `symbol` → `identity` (see TODO.md) |
| 2. Update JSON Schema, TypeScript types, Rust types | ||
| 3. Update all documentation and examples | ||
| 4. See **GRAM-HS-JSON-ALIGNMENT.todo.md** for detailed tasks | ||
| 4. See **pattern-hs-JSON-ALIGNMENT.todo.md** for detailed tasks |
There was a problem hiding this comment.
This references pattern-hs-JSON-ALIGNMENT.todo.md, but that file does not exist in the repository. Add it or update this reference to an existing doc to avoid dead links.
| **Action Items**: | ||
| 1. ✅ Created GRAM-HS-JSON-ALIGNMENT.todo.md for gram-hs changes | ||
| 1. ✅ Created pattern-hs-JSON-ALIGNMENT.todo.md for pattern-hs changes | ||
| 2. ✅ Updated ALIGNMENT.todo.md Phase 0 for gram-rs changes |
There was a problem hiding this comment.
Action item references ALIGNMENT.todo.md, but there is no such file in this repository. Either add the file (if it’s intended to exist here) or update the reference to the correct location/name so the action item is actionable.
| 2. ✅ Updated ALIGNMENT.todo.md Phase 0 for gram-rs changes | |
| 2. ✅ Updated gram-rs Phase 0 alignment plan for gram-rs changes |
| @@ -1,6 +1,6 @@ | |||
| # Gram HS | |||
There was a problem hiding this comment.
The README title still says "Gram HS", but this PR’s purpose is to rename the project/repo to "pattern-hs". Update the heading to match the new project name so the README is consistent with the rest of the renames.
| # Gram HS | |
| # pattern-hs |
| @@ -199,13 +199,13 @@ Generate test patterns and data for your implementation: | |||
|
|
|||
| ```bash | |||
| # Generate test patterns | |||
| gram-hs generate --type pattern --count 100 --format json > test-patterns.json | |||
| pattern-hs generate --type pattern --count 100 --format json > test-patterns.json | |||
|
|
|||
| # Generate test graphs | |||
| gram-hs generate --type graph --count 50 --format gram > test-graphs.gram | |||
| pattern-hs generate --type graph --count 50 --format gram > test-graphs.gram | |||
|
|
|||
| # Generate property-based test suites | |||
| gram-hs generate --type property --complexity standard --format json > property-tests.json | |||
| pattern-hs generate --type property --complexity standard --format json > property-tests.json | |||
| ``` | |||
There was a problem hiding this comment.
This section/documentation uses pattern-hs as the CLI command (e.g., pattern-hs generate/parse/...), but the repository’s CLI executable is gramref (built via cabal build gramref-cli). Update the examples and wording to invoke gramref ... (and optionally clarify that "pattern-hs" is the repo name, not the binary name).
1 participant
This pull request updates documentation, instructions, and design files to rename the project from "gram-hs" to "pattern-hs" throughout the codebase. The changes ensure consistency in project naming and clarify the canonical JSON format and alignment decisions. The most important changes are grouped below.
Project Naming and Documentation Alignment:
gram-hstopattern-hsin documentation files, including.github/copilot-instructions.md,README.md,JSON-SCHEMA-DECISION.md, and design documents. This includes project structure, CLI tool names, and test directory references. [1] [2] [3] [4] [5] [6] [7] [8]JSON Format and Decision Documentation:
JSON-SCHEMA-DECISION.mdto clarify that "pattern-hs" is the canonical reference implementation, updating field names, rationale, and comparison matrices to reflect the new project name and alignment withgram-rs. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15]Design and Implementation Plans:
pattern-hs-cliinstead ofgram-hs-cli, and adjusted example commands and implementation notes to match the new naming. [1] [2]Reference and Alignment Documentation:
pattern-hsas the Haskell implementation, ensuring alignment discussions are accurate and up-to-date.These updates bring the documentation and project structure in line with the new naming convention, clarify the canonical JSON format, and improve consistency across the codebase.