Refactor TS Docs #278
Merged
Refactor TS Docs #278
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
Member
kraftp
commented
Jan 6, 2025
•
kraftp
commented
- Move the most important TS docs (workflows, steps, transactions...) back to the top level
- Improve and condense their text using material from the Python docs
chuck-dbos
reviewed
Jan 7, 2025
docusaurus.config.js
Outdated
| { | ||
| from: '/typescript/tutorials/configured-instances', | ||
| to: '/typescript/tutorials/programmingmodel/configured-instances', | ||
| to: '/typescript/tutorials/development/configured-instances', |
There was a problem hiding this comment.
I don't think this belongs in the "development" section. Maybe the point of the "development" section was missed. The programming model bit was supposed to be about what your code says and how it works, loosely, "coding". The "development" section was supposed to be about supporting tools and techniques. Configured instances is a coding construct.
chuck-dbos
reviewed
Jan 7, 2025
| These guarantees assume that the application and database may crash and go offline at any point in time, but are always restarted and return online. | ||
|
|
||
| 1. Workflows always run to completion. If a DBOS process crashes while executing a workflow and is restarted, it resumes the workflow from the last completed step. | ||
| 2. [Steps](./step-tutorial.md) are tried _at least once_ but are never re-executed after they complete. If a failure occurs inside a step, the step may be retried, but once a step has completed, it will never be re-executed. |
There was a problem hiding this comment.
I wonder if it is worth saying something like "completed (returned a value or thrown an exception to the calling workflow)". Some people seem to assume "completed" means "completed successfully" but it doesn't of course.
chuck-dbos
approved these changes
Jan 7, 2025
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.