Feat/add better tutorials#77
Merged
Merged
Conversation
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
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.
This pull request primarily updates documentation to reflect changes in the usage of the
twd-jslibrary and its test runner. The main improvements include clarifying imports, ensuring all asynchronous navigation usesawait twd.visit, updating the usage of test modifiers (it.only,it.skip), and enhancing documentation structure and clarity. Additionally, there are minor improvements to the CI execution script and the navigation API documentation.Documentation updates for test runner and usage:
Updated all code samples and documentation to import
describe,it, andbeforeEachfromtwd-js/runnerinstead of directly fromtwd-js, and ensured all calls totwd.visitare awaited for proper async handling. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21]Updated all references and documentation tables to use the new test modifiers (
it.only,it.skip) instead of the olditOnly,itSkipsyntax. [1] [2]Improvements to API and navigation documentation:
twd.visitAPI, which now returns aPromise<void>and accepts an optionalreloadparameter, and updated all code examples accordingly. [1] [2] [3] [4]Enhancements to documentation structure and navigation:
docs/.vitepress/config.mts.CI execution script improvements:
Minor documentation clarifications:
README.md. [1] [2]This closes #73