add a documentation page for the n8n community node - #266
Merged
Merged
Conversation
A page carries its name in three places, and the conventions claimed they had to correspond. They do not: the `.pages` entry is the label in the navigation menu, `title:` in the front matter is the site page title and the entry on the tags page, and the `# Heading` is the visible title on the page itself. A menu label is written for scanning inside its section and is often shorter than the heading. The front matter title is often written longer than the heading, because the tags page lists pages flat, without the hierarchy that would otherwise say what a page belongs to - which is why every cmemc page sets `title: "cmemc: Installation"` against a heading of `Installation`. Divergence between the three is therefore not drift and is not to be corrected. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DoyrnqQWXJBjPFqX1kj5cP
The entries addressed the reader directly ("You can send and receive
messages", "your Knowledge Graphs", "files you created") and spoke for
eccenca in the first person ("by using our Power-BI-Connector"), against
style guide 3.2. They are rewritten in the imperative.
Three unrelated defects in the same texts are fixed along the way:
"and captures its output" (Kubernetes), "to user and groups" and
"in you Mattermost" (Mattermost).
The template comment at the top keeps its "you", as it addresses the author
of an entry rather than a reader of the page.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DoyrnqQWXJBjPFqX1kj5cP
Corporate Memory 26.2 shipped @eccenca/n8n-nodes-corporate-memory, an n8n community node, and the release note was the only place describing it. The page introduces the node, names three use cases (event-driven workflow execution, publishing graph content downstream, Knowledge Graph lookup inside a larger automation), lists the prerequisites and describes the working mode: one credential, one node, three resources and their five actions. Technical detail - installation, credential fields, per-action parameters - stays in the repository README, which the page links to. The credential prerequisite points at a dedicated Keycloak client scoped to what the automation needs, rather than at the broadly privileged cmem-service-account that the Power BI and Redash pages reuse. Also: - lists the page as a fifth card on the Automate landing page - points the n8n entry of the integrations page at it - points the 26.2 release note at it instead of at npm - maps the Integration tag in mkdocs.yml The screenshot is the one from the 26.2 release note. No version number appears on the page, so it does not age with the next npm release. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DoyrnqQWXJBjPFqX1kj5cP
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the missing documentation page for the n8n community node that shipped with Corporate Memory 26.2, and carries two changes that came out of writing it.
This is the part that needs a second opinion, because it reverses a rule the repository has been enforcing.
.claude/docs-guidelines/repo-conventions.mdstated:That is wrong. A page carries its name in three places, and each serves a different purpose:
.pagesfiletitle:in the Markdown front matter# Headingat the top of the MarkdownThey legitimately diverge in both directions. A menu label competes for horizontal space and is read inside its section, so it is often shorter than the heading. The front matter title is often longer than the heading, because the tags page lists pages flat, stripped of the hierarchy that would otherwise say what a page belongs to — which is exactly why every cmemc page sets
title: "cmemc: Installation"against a heading ofInstallation.The consequence for anyone editing: do not "fix" such a divergence as if it were drift, and in particular do not rewrite a deliberately chosen
.pagesentry just because the heading says something else.The new page is itself an instance of this:
.pagesn8n Integration— reads well next to Continuous Integration and Scheduling Workflowstitle:n8n: Corporate Memory Community Node— self-describing in a flat tag listing# Headingn8n Community NodeThe corrected rule is recorded in both
repo-conventions.mdandCLAUDE.md.The page
docs/automate/n8n-node/index.md— introduction, use cases, prerequisites, working mode.cmem-service-accountthat the Power BI and Redash pages reuse. Worth a look — it is a deliberate departure from the existing precedent.The screenshot is the one already published in the 26.2 release note.
Also in this commit: a fifth card on the Automate landing page, the integrations entry repointed at the page, the 26.2 release note pointed at the page instead of at npm, and an
Integrationtag mapping inmkdocs.yml.Integrations entries rewritten in the imperative
The entries in
data/integrations.ymladdressed the reader directly ("You can send and receive messages", "your Knowledge Graphs", "files you created") and spoke for eccenca in the first person ("by using our Power-BI-Connector"), against style guide 3.2. Nine entries are rewritten.Three unrelated defects in the same texts are fixed along the way: "and captures its output" (Kubernetes), "to user and groups" and "in you Mattermost" (Mattermost).
The template comment at the top of the file keeps its "you" — it addresses the author of an entry, not a reader of the page.
Notes for the reviewer
task checkpasses on every commit.Integrationtag I found there is nomd-tag--*CSS anywhere in the repo, so the value inextra.tagsacts as a slug and no icon asset is needed.repo-conventions.mdclaims an unmapped tag "renders without an icon", which appears to overstate what this build does — left alone, not verified end to end.🤖 Generated with Claude Code
https://claude.ai/code/session_01DoyrnqQWXJBjPFqX1kj5cP