Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document all synpress commands in docs/synpress-commands.md #645

Merged
merged 1 commit into from
Feb 23, 2023

Conversation

neuodev
Copy link
Contributor

@neuodev neuodev commented Feb 23, 2023

This PR document the Synpress Commands (API) in a markdown instead of having it only in the types.d.ts file

@drptbl
Copy link
Collaborator

drptbl commented Feb 23, 2023

@AhmedIbrahim336 Thanks for PR! This is awesome. 👏

In future we could have a script which would generate this file automatically - would save a lot of work! I'm happy to incentivise with small bounty for such feature (in sUSD).

@drptbl drptbl merged commit 708dbc4 into Synthetixio:dev Feb 23, 2023
@neuodev
Copy link
Contributor Author

neuodev commented Feb 23, 2023

@drptbl No need to pay! I will do it! I will submit a PR this weekend.

So the script Idea will be to read the index.d.ts and parse it (mostly using regexp) then output a readme file!

I am happy to contribute!

@drptbl
Copy link
Collaborator

drptbl commented Feb 23, 2023

AhmedIbrahim336

@drptbl No need to pay! I will do it! I will submit a PR this weekend.

So the script Idea will be to read the index.d.ts and parse it (mostly using regexp) then output a readme file!

I am happy to contribute!

That's correct. Happy to see your contributions 🚀.

@cypress cypress bot mentioned this pull request Feb 23, 2023
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