Documentation Templates and Checklist for Publishing

Questions
1

Hi,
We’re currently developing a custom integration(n8n nodes, Product Credential and workflows) and would like to publish it on the n8n Marketplace.

References that we found for publishing are

Could you please guide us on the following?

  • Are there any templates for creating the README and user documentation/guide,
  • What are the steps for documentation publishing ( We did find a n8n-docs repository, do we need to submit documentation here)?
  • Is there any official documentation or checklist we should follow before submitting the node?
  • Pls share the corresponding procedure for Workflows as well.

If you could share the relevant guidelines or resources, that would be really helpful.
Thanks in advance!

2

Hey @Abhi_Shah, while you wait for a response, here are some things that might help:

Suggested resources

Automatically matched to your question.

Docs:

Forum:

@Anshul_Namdev - you’ve helped with similar issues before, can you take a look?

Automatically suggested by n8n’s community bot. It’s a pilot - please share feedback here.

3

@Abhi_Shah Hello!
For templates, this is the best resource I have - here

Use this link, to submit your node and get it verified - here

For workflows to the templates page use this -here
(same link for both)

In your workflow, you can use sticky notes for documentation, but also on the creator hub you put a description.

The documentation below will explain the process, and inside the creator hub UI, you can see more instructions!
Workflow docs

Node documentation

You can also contribute here on the forum to show your work to, or the github!

4

Hi @Abhi_Shah
Community node documentation doesn’t go into the n8n-docs repository. For verification the documentation requirement is a README in the npm package or in a related public repository, so that README is your user guide. The n8n-docs repo does hold page templates you can borrow as a structure for it, app-nodes.md, credentials.md and common-issues.md sit in its document-templates/ folder:

The checklist n8n reviews against before verification: scaffold from the n8n-node CLI, pass the technical guidelines with no run-time dependencies at all, follow the UX guidelines, ship the README, and publish to npm from a GitHub Actions workflow with a provenance statement. That last one is required for Creator Portal verification since May 1st 2026, packages published from a local machine won’t be accepted.

5

Hi @achamm, @Anshul_Namdev,

Thank you for your quick responses. Quite a few things have been clarified.

We’re developing a set of nodes for a product, along with the product’s custom credentials and a few pre-defined workflows.

Regarding the npm package, we’re now clear on the publishing requirements:

  • README included with the npm package, covering each node in the app-nodes.md format
  • Publishing the npm package via GitHub Actions with a provenance statement
  • Verifying the nodes and workflows through Creator login

However, while going through the n8n docs repository, we had one confusion we’d like to clarify. Apologies if this feels like a repetition of my previous question.

Since our integration has dedicated credentials, do we also need to add a credentials.md to the n8n docs repository and raise a separate PR there?

Thanks again for your help!

6

@Abhi_Shah Nope! That’s for integrated nodes, like ones that are in n8n directly, from what I saw on the docs, you won’t need it!

Your entire node documentation just goes in your packages README, that’s it!