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

Code Bundling Doc assumes knowledge of Node.js #153

Open
steve-hickman-epistimis opened this issue May 23, 2023 · 2 comments
Open

Code Bundling Doc assumes knowledge of Node.js #153

steve-hickman-epistimis opened this issue May 23, 2023 · 2 comments
Labels
recipe Improvements or additions to recipes

Comments

@steve-hickman-epistimis
Copy link
Contributor

The node script at the top of https://langium.org/guides/code-bundling/ assumes the reader knows how to set up a Node.js script. Can you just link to a properly configured version of this script in your repo that users can just use? Or, at least, provide a completely configured file with all the info needed to set it up to execute. Otherwise readers like me have to read Node.js doc and figure this out - and it's not completely straightforward.

@spoenemann spoenemann transferred this issue from eclipse-langium/langium May 24, 2023
@spoenemann spoenemann added the recipe Improvements or additions to recipes label May 24, 2023
@msujew
Copy link
Contributor

msujew commented May 24, 2023

Since Langium advertises itself as a Language Engineering framework for TypeScript and Node.js, I believe it's safe for us to assume that most devs have at least some JS/Node.js experience. It's fine not to have it, but you will need to get around it in one way or another if you plan on working with Langium for more than just a few days anyway.

I tend to say this is a bit out of scope for our guide website. We are building a framework for a dedicated runtime, and can expect some level of proficiency in that runtime from devs. @spoenemann what is your opinion on that?

@spoenemann
Copy link
Contributor

I agree. But we could add links to Node.js or other third-party documentation where appropriate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
recipe Improvements or additions to recipes
Projects
None yet
Development

No branches or pull requests

3 participants