fix(app-typescript): add expected output and troubleshooting to writi… #446
Conversation
adam-cowley
force-pushed
the
fix-app-typescript-20251202
branch
from
bae103d to
fd606c5
Compare
| ---- | ||
|
|
||
| You can check the result in the Neo4j Browser by running the following query: | ||
| If successful, you should see output similar to the following (with your name instead of "Your Name"): |
There was a problem hiding this comment.
Providing a view of what the user should see is a good addition.
It gives learners:
- an indication that they have completed a task successfully
- confidence that they can progress.
| RETURN m, a, p | ||
| ---- | ||
|
|
||
| You should see your `Person` node connected to _The Matrix_ movie. |
There was a problem hiding this comment.
Same as above. Tell the learner what the expect outcome should be.
|
|
||
| == Troubleshooting | ||
|
|
||
| .ts-node: command not found |
There was a problem hiding this comment.
Troubleshooting - good idea for complex activities. Used as a last resort, we should design the course content so that these scenarios are few, and prepare the learner to be able to solve their own issues.
Im not sure about giving multiple options for fixing an issue:
. use ts-node
. or npx
It prompts questions for the learner:
- Which one should I use?
- Is one better than the other?
- Why am I experiencing this problem?
I would direct them back to the installation instructions in the course which should be comprehensive / robust enough to cover the majority of scenarios.
| ---- | ||
| ==== | ||
|
|
||
| .Cannot use import statement outside a module |
There was a problem hiding this comment.
Feels like a [TIP] if its something we expect to happen often.
We cant control all environment issues on all learners computers though - this is why codespaces are such a positive.
| ---- | ||
| ==== | ||
|
|
||
| .Verification fails but code works |
There was a problem hiding this comment.
Ok. We could end up putting this on every lesson where the code uses the database though. I would prefer a test at the start to ensure everything is setup correctly before proceeding.
Summary
Improves the "Writing Data to Neo4j" lesson in the TypeScript course based on user feedback (84% negative rating).
Changes
Added Expected Output section
Users now see what successful output looks like before running verification, so they can confirm their code works independently of the verify button.
Added Troubleshooting section (collapsible)
Three common issues addressed:
ts-node: command not foundnpx ts-nodeCannot use import statement outside a modulenpx ts-node --esmflagFeedback addressed
c36f4359-ae13-4954-a7e6-ac04b7bab6ea78115078-1dc8-4091-837b-dd37f2efa80b75c5b45e-d95e-4da6-9df8-7cf1d36ff5819cea838f-85ab-4a69-a656-3a0b9a925d8cf8bec257-7334-4b34-9f12-6c09d2f68824d89143d6-39b3-4881-bfa8-ac64d9a711deFiles changed
asciidoc/courses/app-typescript/modules/1-driver/lessons/5-c-writing-data/lesson.adocNotes
Some feedback issues (JSON errors, sandbox provisioning failures) are infrastructure-related and cannot be addressed through content changes alone.