Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[Documentation outdated] Run your node locally #62

Open
srcmkr opened this issue Jan 3, 2025 · 1 comment
Open

[Documentation outdated] Run your node locally #62

srcmkr opened this issue Jan 3, 2025 · 1 comment

Comments

@srcmkr
Copy link

srcmkr commented Jan 3, 2025

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

  • 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.

@Joffcom
Copy link
Member

Joffcom commented Jan 3, 2025

Hey @srcmkr,

We have created an internal ticket to look into this which we will be tracking as "N8N-8040"

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

No branches or pull requests

2 participants