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

Write documentation #1

Open
tobiasvl opened this issue Nov 8, 2022 · 2 comments · May be fixed by #7
Open

Write documentation #1

tobiasvl opened this issue Nov 8, 2022 · 2 comments · May be fixed by #7
Labels
documentation Improvements or additions to documentation

Comments

@tobiasvl
Copy link

tobiasvl commented Nov 8, 2022

This seems really interesting! Are there plans for more (or any) documentation on the VM?

@evie-calico
Copy link
Owner

Yes, the language is in pretty dire need of documentation but I've been putting it off since I'm the only user I know of ^^

Ideally I'd document the basic features of the language and provide some explanations for more unique features like the environments. The VM part would be pretty simple to document as well so I don't see that being an issue.

@evie-calico evie-calico self-assigned this Nov 8, 2022
@evie-calico evie-calico added the documentation Improvements or additions to documentation label Nov 8, 2022
@ISSOtm
Copy link
Contributor

ISSOtm commented Jan 14, 2024

I'm currently working on a mdBook-based manual. Currently, I'm planning to first show how the script syntax works, then explain what it gets compiled to, and how that's controlled via env blocks.

@ISSOtm ISSOtm linked a pull request Jan 17, 2024 that will close this issue
@evie-calico evie-calico removed their assignment Mar 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants