Open
Conversation
Replace existing Learn Effection documentation with comprehensive Hydra tutorial content. The new tutorial provides: - Progressive 11-chapter learning path from basics to advanced - New quick-start guide (~50 lines condensed hello world) - Capstone project examples (Multiplex HTTP Proxy) - Merged events content into signals chapter Structure changes: - Getting Started: Installation, TypeScript, Quick Start, Rosetta Stone, Upgrade - Tutorial: 11 chapters covering operations, actions, spawn, combinators, resources, channels, signals, streams, context, and scope API - Examples: Multiplex proxy capstone with server resource, pool, switchboard - Reference: Error handling, FAQ, Processes Removed old files: operations.mdx, spawn.mdx, resources.mdx, collections.mdx, context.mdx, actions.mdx, scope.mdx, thinking-in-effection.mdx, events.mdx, tutorial.mdx
commit: |
Add hand-crafted SVG diagrams with dark/light mode support to replace ASCII art diagrams in the tutorial documentation. New SVG files: - diagrams/_template.svg - reusable template for doc diagrams - diagrams/multiplex-proxy-architecture.svg - architecture overview - diagrams/switchboard-request-flow.svg - request flow sequence - diagrams/resources-lifecycle.svg - resource provide/cleanup lifecycle - diagrams/streams-hierarchy.svg - Stream type hierarchy - diagrams/final-assembly-tree.svg - operation tree structure - diagrams/final-assembly-fire-doors.svg - scoped() isolation pattern Updated MDX files to use <img data-inline-svg> for SVG embedding. All diagrams adapt to system light/dark mode preference.
Move diagrams from docs/diagrams/ to www/assets/diagrams/ so they are served at /assets/diagrams/ URLs. Update all MDX files to use absolute paths. The inline-svg plugin resolves relative paths against the request URL, not the source file location, so diagrams need to be in the www assets directory to be found correctly.
- Replace yield* Promise.resolve() with yield* call() in scope-api docs - Replace await inside function* with yield* call() in server-pool example These patterns would not compile - yield* Promise doesn't work (as noted in the FAQ) and await cannot be used inside generator functions.
Member
|
This complicates the navigation on the left. We either need to sort that, or maybe have the tutorial be a separate top-level item. |
Member
Author
|
We need to improve the left sidebar anyway. I want to do a bit of a A/B testing on this content. I don't know if this is better than what we have right now. |
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
2 participants
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.
Motivation
The existing Learn Effection documentation, while functional, lacked a progressive learning path and comprehensive examples. The Hydra tutorial content from the thefrontside/hydra repo provides a more thorough, step-by-step approach to learning Effection with real-world examples culminating in a capstone project.
This PR replaces the existing docs with Hydra's content to:
Approach
New Tutorial Structure (11 chapters):
New Examples Section (Capstone Project):
Getting Started Changes:
Deleted Old Files:
All code examples are inlined in MDX (no separate .ts files needed).