Add spec aided by claude code #966
Merged
Conversation
This file contains 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
| - Integration tests: `yarn test:int` (start deps: `yarn test:int:deps`, stop: `yarn test:int:deps:down`) | ||
|
|
||
| ## Code Style Guidelines | ||
| - **TypeScript**: Target ES2021, NodeNext modules, strict typing enabled |
There was a problem hiding this comment.
not correct atm - would be nice if it were, though
|
|
||
| ## Code Style Guidelines | ||
| - **TypeScript**: Target ES2021, NodeNext modules, strict typing enabled | ||
| - **Formatting**: 2-space indentation, 80 char width, double quotes, semicolons required |
There was a problem hiding this comment.
probably good if it tries to keep to 80 or 120 char width, but we don't enforce this
| - **Channels Layer**: Base communication & state management (BaseChannel, LastValue, Topic) | ||
| - **Checkpointer Layer**: Persistence and state serialization across backends | ||
| - **Pregel Layer**: Message passing execution engine with superstep-based computation | ||
| - **Graph Layer**: High-level APIs for workflow definition (Graph, StateGraph) |
There was a problem hiding this comment.
missing functional API
Comment on lines
35
to
40
| * Communication Model: | ||
| * - Nodes NEVER communicate directly with each other | ||
| * - All communication is mediated through Channels | ||
| * - Nodes subscribe to Channels to receive data | ||
| * - Nodes write to Channels to share data | ||
| * - Channels can customize how values are accumulated (last value, append to list, etc.) |
There was a problem hiding this comment.
Worth mentioning values here? it's kind of mentioned in the last point, but not explicitly
Comment on lines
136
to
147
| * Key Classes: | ||
| * - Graph: Base graph class for defining workflow structure | ||
| * - StateGraph: Specialized graph for stateful workflows | ||
| * - CompiledGraph (extends Pregel): Runtime representation of a graph | ||
| * - Annotation: Type specification for graph state | ||
| * - Branch: Handles conditional routing between nodes | ||
| * | ||
| * Core Functionality: | ||
| * - Graph Construction: Define nodes, edges, and execution flow | ||
| * - State Definition: Specify and validate state schemas | ||
| * - Compilation: Transform graph definitions into executable Pregel instances | ||
| * - Visualization: Generate visualizations of graph structure |
There was a problem hiding this comment.
Might be hard to define here, but it'd be nice if there was some (even terse) statements that said how each of these map to the pregel model
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.
Fixes # (issue)