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

Improve doc: Link to this repo and state latest released version on toolkit doc page at scala-lang.org, and include concrete example of using directive #60

Open
bjornregnell opened this issue Dec 13, 2024 · 2 comments

Comments

@bjornregnell
Copy link
Contributor

I think it would be helpful to state the latest version released of the toolkit on the doc page here:
https://docs.scala-lang.org/toolkit/introduction.html

And also link to its home on github: https://github.com/scala/toolkit

As a user I want to know how to pin down the latest/default version in my using directive //> using toolkit x.y.z

@bjornregnell
Copy link
Contributor Author

bjornregnell commented Dec 13, 2024

I also think it would be helpful if the Introduction page included an actual example of how to use the toolkit as a using-directive both with default and with a specific version.

//> using toolkit default

or pinned:

//> using toolkit 0.6.0

@bjornregnell bjornregnell changed the title Link to this repo and state latest released version on toolkit doc page at scala-lang.org Improve doc: Link to this repo and state latest released version on toolkit doc page at scala-lang.org, and include concrete example of using directive Dec 13, 2024
@adpi2
Copy link
Member

adpi2 commented Dec 16, 2024

Thanks for the suggestions! I fully agree and support these changes.

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

No branches or pull requests

2 participants