Skip to content

Feat/add better tutorials#77

Merged
kevinccbsg merged 16 commits into
mainfrom
feat/add-better-tutorials
Nov 10, 2025
Merged

Feat/add better tutorials#77
kevinccbsg merged 16 commits into
mainfrom
feat/add-better-tutorials

Conversation

@kevinccbsg

@kevinccbsg kevinccbsg commented Nov 10, 2025

Copy link
Copy Markdown
Member

This pull request primarily updates documentation to reflect changes in the usage of the twd-js library and its test runner. The main improvements include clarifying imports, ensuring all asynchronous navigation uses await 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, and beforeEach from twd-js/runner instead of directly from twd-js, and ensured all calls to twd.visit are 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 old itOnly, itSkip syntax. [1] [2]

Improvements to API and navigation documentation:

  • Documented the updated twd.visit API, which now returns a Promise<void> and accepts an optional reload parameter, and updated all code examples accordingly. [1] [2] [3] [4]

Enhancements to documentation structure and navigation:

  • Improved documentation navigation by adding new tutorial links (such as "Introduction" and "Code Coverage") and reorganizing the sidebar in docs/.vitepress/config.mts.

CI execution script improvements:

  • Enhanced the CI script for running tests by adding timing logs, explicit waits for page elements, and improved logging for better feedback during automated runs. [1] [2]

Minor documentation clarifications:

  • Clarified that the documentation site is "complete and updated" and removed the beta warning from the README.md. [1] [2]

This closes #73

@kevinccbsg kevinccbsg merged commit b790749 into main Nov 10, 2025
4 checks passed
@kevinccbsg kevinccbsg deleted the feat/add-better-tutorials branch November 10, 2025 01:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] improve tutorial

1 participant