Skip to content

Document how to create custom toolkits #2639

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

Closed
Gedochao opened this issue Dec 18, 2023 · 7 comments · Fixed by #2715
Closed

Document how to create custom toolkits #2639

Gedochao opened this issue Dec 18, 2023 · 7 comments · Fixed by #2715
Labels
Community help wanted Issues that idicate features that are nice-to-have but core team does not have time to work on it documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Gedochao
Copy link
Contributor

Is your feature request related to a problem? Please describe.
The toolkit guide does not include an explanation on how to create a custom toolkit from scratch.

Describe the solution you'd like
An extra section in the doc describing how to create custom toolkits.

Additional context
Created out of #2637

@Gedochao Gedochao added documentation Improvements or additions to documentation enhancement New feature or request Community help wanted Issues that idicate features that are nice-to-have but core team does not have time to work on it labels Dec 18, 2023
@yadavan88
Copy link
Contributor

In that doc section, it would be nice if the some of these info added:

  • How to created custom toolkit and step to publish for usage?
  • Difference between custom toolkit and default toolkit usage
  • Some info on how custom toolkit differ from using a directive
  • An example toolkit implementation if possible

@Gedochao
Copy link
Contributor Author

An extra section in the doc describing how to create custom toolkits.

I actually wonder whether it should be an extra section in the general Scala Toolkit doc, or whether we should have a separate advanced guide/cookbook on building custom toolkits.

@yadavan88
Copy link
Contributor

@Gedochao Probably a separate guide might be better as this might not be interest to everyone using the toolkit.
I would be happy to help with this, if someone can guide me on the process/step.

@Gedochao
Copy link
Contributor Author

@Gedochao Probably a separate guide might be better as this might not be interest to everyone using the toolkit.

Agreed. It'd be good to linke to it from the existing Scala Toolkit guide, though, so that it's easy to find.

I would be happy to help with this, if someone can guide me on the process/step.

@yadavan88 Awesome, sure!
The docs live under the ./website/docs directory.
The existing Scala Toolkit doc can be edited here: https://github.com/VirtusLab/scala-cli/blob/main/website/docs/guides/introduction/toolkit.md
I'd imagine a new custom toolkits guide should go to the advanced category here: https://github.com/VirtusLab/scala-cli/tree/main/website/docs/guides/advanced
When adding a new guide, be sure to add it to the index at https://github.com/VirtusLab/scala-cli/blob/main/website/docs/guides/intro.md

When doing docs-only changes, you can branch from stable and create a PR to stable, so that the changes get deployed to the website when they're merged and not with the next Scala CLI release.

Otherwise, refer to CONTRIBUTING.md for more general rules for contributions.
Let me know if you need help.

@yadavan88
Copy link
Contributor

Thanks for the details @Gedochao
I will create the new PR and let you know.

@yadavan88
Copy link
Contributor

Hi @Gedochao
I created a new PR with the documentation for the custom toolkit. Please share your feedback.

Thanks
Yadu

@Gedochao Gedochao linked a pull request Feb 7, 2024 that will close this issue
@yadavan88
Copy link
Contributor

Hi @Gedochao
Thanks for merging the PR. I think something is wrong in the styles. https://scala-cli.virtuslab.org/docs/guides/advanced/custom-toolkit
I created a PR to fix this issue. Could you have a look?

@Gedochao Gedochao closed this as completed Feb 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community help wanted Issues that idicate features that are nice-to-have but core team does not have time to work on it documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants