You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Current issue
The documentation still references npm commands (specifically npm link), but the repository has migrated to pnpm. This makes it challenging for new contributors to test their nodes locally as the documented approach no longer works.
Impact
Having up-to-date documentation is crucial for encouraging community contributions. As someone who isn't primarily a TypeScript developer, I find myself struggling with the current setup process. While I'm capable of adapting and implementing code when given clear examples and documentation, the outdated information creates an unnecessary barrier.
This is particularly important because
Clear documentation and working examples are essential for non-TypeScript developers who want to contribute.
The easier it is for new developers to get started, the more likely they are to create and share new nodes.
A larger variety of nodes and plugins directly contributes to n8n's ecosystem growth.
Suggested improvements
Update the guide to use pnpm commands instead of npm
Consider adding a note about the migration from npm to pnpm
Include any additional steps specific to the pnpm workflow
Consider adding more detailed examples that newer developers can use as reference (e.g. step-by-step commands, maybe screenshots)
While I wish I could contribute to fixing this documentation myself, I'm still learning the ropes. However, I believe addressing this would significantly help other developers in similar situations who want to contribute to the project.
I'm happy to provide additional feedback or testing from a new developer's perspective. Thank you for maintaining this great project! 🙌
Let me know if you'd like me to clarify anything about this issue.
The text was updated successfully, but these errors were encountered:
Hi n8n team! 👋
I'd like to bring attention to the documentation for "Run your node locally" (https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/), which needs updating to reflect the current development workflow.
Current issue
The documentation still references npm commands (specifically npm link), but the repository has migrated to pnpm. This makes it challenging for new contributors to test their nodes locally as the documented approach no longer works.
Impact
Having up-to-date documentation is crucial for encouraging community contributions. As someone who isn't primarily a TypeScript developer, I find myself struggling with the current setup process. While I'm capable of adapting and implementing code when given clear examples and documentation, the outdated information creates an unnecessary barrier.
This is particularly important because
Suggested improvements
While I wish I could contribute to fixing this documentation myself, I'm still learning the ropes. However, I believe addressing this would significantly help other developers in similar situations who want to contribute to the project.
I'm happy to provide additional feedback or testing from a new developer's perspective. Thank you for maintaining this great project! 🙌
Let me know if you'd like me to clarify anything about this issue.
The text was updated successfully, but these errors were encountered: