Skip to content

Conversation

@zikani03
Copy link
Owner

@zikani03 zikani03 commented Sep 22, 2025

This changeset adds a new sub-command named run-doc which can be used to generate markdown from the steps in the .basi file as a way to aid in documenting steps for applications in addition to testing them.

This is very early and very experimental, lot's of things to figure out. But it works okay enough for a first pass,

Usage:

$ basi run-doc example-hn.basi

You will get a markdown with the following (Screenshots are added between each step and referenced in the markdown ):

# Test Document for  

Documented by Basi

1. Goto https://news.ycombinator.com/login

![[Figure 2]](./step-0.png)

2. Fill input[name=acct]

![[Figure 3]](./step-1.png)

3. Fill input[name=pw]

![[Figure 4]](./step-2.png)

4. Click input[value=login]

![[Figure 5]](./step-3.png)

![[Figure 5]](./test-screenshot.png)

This changeset adds a new sub-command named run-doc which can be used
to generate markdown from the steps in the .basi file as a way to aid
in documenting steps for applications in addition to testing them.

This is very early and very experimental, lot's of things to figure out.
But it works okay enough for a first pass
@zikani03 zikani03 force-pushed the feat/run-and-generate-documentation branch from e79d551 to 39dcf28 Compare September 22, 2025 15:40
Signed-off-by: Zikani Nyirenda Mwase <zikani.nmwase@ymail.com>
@zikani03 zikani03 merged commit b89f4cd into main Sep 25, 2025
1 check passed
@zikani03 zikani03 deleted the feat/run-and-generate-documentation branch September 25, 2025 08:37
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.

2 participants