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

Update, remove or document pl-tutorial #3704

Closed
Baltoli opened this issue Oct 12, 2023 · 5 comments · Fixed by #3717
Closed

Update, remove or document pl-tutorial #3704

Baltoli opened this issue Oct 12, 2023 · 5 comments · Fixed by #3717
Assignees

Comments

@Baltoli
Copy link
Contributor

Baltoli commented Oct 12, 2023

The PL tutorial is leading to confusion from external users who are unable to complete the lessons as written with modern K: #3698

We should do one of the following things:

  • Update the lessons to reflect the current set of features supported by modern K
  • Remove the broken code (rather than just dropping it silently from CI)
  • Document externally that this tutorial is out of date and should not be relied on
@Baltoli
Copy link
Contributor Author

Baltoli commented Oct 12, 2023

Worth noting that we link to this content directly from the https://kframework.org/ landing page, so we really ought to resolve this one way or another.

@Baltoli
Copy link
Contributor Author

Baltoli commented Oct 12, 2023

@dwightguth favours the documentation option; we should also update the website homepage to reflect that. Best option as a stopgap

@Baltoli
Copy link
Contributor Author

Baltoli commented Oct 12, 2023

Is @grosu still using this code for anything teaching-related?

@Baltoli Baltoli self-assigned this Oct 12, 2023
@QWYNG
Copy link

QWYNG commented Oct 13, 2023

@Baltoli
Thank you for opening this issue!
Currently, is there any other documentation you would recommend for a beginning student to learn k?

@Baltoli
Copy link
Contributor Author

Baltoli commented Oct 13, 2023

https://kframework.org/k-distribution/k-tutorial/ The K tutorial is the best place to learn K as a programming language; the PL tutorial that you had the issue with is more of a reference for "how can I implement language X in K?

If you've finished the K tutorial, and would like some advice on using K in practice for a project, come and find us on Discord: https://discord.com/invite/CurfmXNtbN

@Baltoli Baltoli linked a pull request Oct 18, 2023 that will close this issue
rv-jenkins added a commit that referenced this issue Oct 19, 2023
Partially addresses #3704
by de-emphasising the PL tutorial on the main K webpage. Happy to
bikeshed the specific placement and wording used here.

---------

Co-authored-by: rv-jenkins <admin@runtimeverification.com>
@Baltoli Baltoli closed this as completed Oct 19, 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 a pull request may close this issue.

2 participants