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

[REQ] update docs with tutorials #297

Open
1 task done
pmengelbert opened this issue Jun 24, 2024 · 0 comments
Open
1 task done

[REQ] update docs with tutorials #297

pmengelbert opened this issue Jun 24, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@pmengelbert
Copy link
Contributor

What kind of request is this?

Improvement of existing experience

What is your request or suggestion?

The existing docs are thorough and clear. But through experience I have found that many people I've directed to the docs have copied and pasted the examples without reading the text, preferring to play around with dalec rather than read the docs. We should create a set of tutorial docs that play into this tendency, with the following constraints:

  • It is a series of examples, with minimal textual explanation
  • The examples all compile properly without modification
  • The examples are graded from extremely simple to multiple sources with complex build steps and generators.

Are you willing to submit PRs to contribute to this feature request?

  • Yes, I am willing to implement it.
@pmengelbert pmengelbert added the enhancement New feature or request label Jun 24, 2024
@pmengelbert pmengelbert changed the title [REQ] update docs [REQ] update docs with tutorials Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant