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: add some more tutorials/getting started guides #2479

Open
lidavidm opened this issue Jan 22, 2025 · 0 comments
Open

docs: add some more tutorials/getting started guides #2479

lidavidm opened this issue Jan 22, 2025 · 0 comments
Labels
Type: enhancement New feature or request

Comments

@lidavidm
Copy link
Member

What feature or improvement would you like to see?

There's some interesting recommendations here: https://refactoringenglish.com/chapters/rules-for-software-tutorials/

I think we could structure a tutorial as a series of minimal, self-contained, working recipes (possibly extending the recipe directive to trim down what's included to a certain line range), which would help make sure the recipes get tested in CI. The only other thing might be tooling to ensure that the steps actually progress into each other and don't get out of sync (preventing you from making an edit to only one step).

@lidavidm lidavidm added the Type: enhancement New feature or request label Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant