n8n-io / n8n-docs

Documentation for n8n, a fair-code licensed automation tool with a free community edition and powerful enterprise options. Build AI functionality into your workflows.
https://docs.n8n.io
Other
134 stars 251 forks source link

DOC-894: Update look and feel of Node base file page #2183

Closed freakwriter closed 3 weeks ago

freakwriter commented 3 weeks ago

Includes these updates:

netlify[bot] commented 3 weeks ago

Deploy Preview for n8n-docs ready!

Name Link
Latest commit 7f9bc4b2fc7cf4718ebf2625d482d4ee83ea7b67
Latest deploy log https://app.netlify.com/sites/n8n-docs/deploys/667bc42ed7a5e20008152e83
Deploy Preview https://deploy-preview-2183--n8n-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions[bot] commented 3 weeks ago

Overall readability score: 41.16 (🟢 +0.09)

File Readability
declarative-style-parameters.md 62.32 (-)
index.md 67.82 (-)
programmatic-style-execute-method.md 56.57 (-)
programmatic-style-parameters.md 63.44 (-)
standard-parameters.md 75.47 (-)
structure.md 60.62 (-)
View detailed metrics 🟢 - Shows an _increase_ in readability 🔴 - Shows a _decrease_ in readability File | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- [declarative-style-parameters.md](https://github.com/n8n-io/n8n-docs/blob/7f9bc4b2fc7cf4718ebf2625d482d4ee83ea7b67/docs/integrations/creating-nodes/build/reference/node-base-files/declarative-style-parameters.md "docs/integrations/creating-nodes/build/reference/node-base-files/declarative-style-parameters.md") | 62.32 | 47.18 | 9.32 | 10.5 | 11.13 | 7.85   | - | - | - | - | - | - [index.md](https://github.com/n8n-io/n8n-docs/blob/7f9bc4b2fc7cf4718ebf2625d482d4ee83ea7b67/docs/integrations/creating-nodes/build/reference/node-base-files/index.md "docs/integrations/creating-nodes/build/reference/node-base-files/index.md") | 67.82 | 59.5 | 7.07 | 11.3 | 12.98 | 6.8   | - | - | - | - | - | - [programmatic-style-execute-method.md](https://github.com/n8n-io/n8n-docs/blob/7f9bc4b2fc7cf4718ebf2625d482d4ee83ea7b67/docs/integrations/creating-nodes/build/reference/node-base-files/programmatic-style-execute-method.md "docs/integrations/creating-nodes/build/reference/node-base-files/programmatic-style-execute-method.md") | 56.57 | 47.18 | 8.29 | 12.3 | 13.22 | 8.46   | - | - | - | - | - | - [programmatic-style-parameters.md](https://github.com/n8n-io/n8n-docs/blob/7f9bc4b2fc7cf4718ebf2625d482d4ee83ea7b67/docs/integrations/creating-nodes/build/reference/node-base-files/programmatic-style-parameters.md "docs/integrations/creating-nodes/build/reference/node-base-files/programmatic-style-parameters.md") | 63.44 | 49.62 | 8.31 | 10.9 | 12.4 | 7.43   | - | - | - | - | - | - [standard-parameters.md](https://github.com/n8n-io/n8n-docs/blob/7f9bc4b2fc7cf4718ebf2625d482d4ee83ea7b67/docs/integrations/creating-nodes/build/reference/node-base-files/standard-parameters.md "docs/integrations/creating-nodes/build/reference/node-base-files/standard-parameters.md") | 75.47 | 60.41 | 6.88 | 9 | 10.65 | 6.63   | - | - | - | - | - | - [structure.md](https://github.com/n8n-io/n8n-docs/blob/7f9bc4b2fc7cf4718ebf2625d482d4ee83ea7b67/docs/integrations/creating-nodes/build/reference/node-base-files/structure.md "docs/integrations/creating-nodes/build/reference/node-base-files/structure.md") | 60.62 | 42.78 | 7.45 | 11.8 | 14.31 | 7.17   | - | - | - | - | - | - Averages:   | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- Average | 41.16 | 33.71 | 12.02 | 15.34 | 14.45 | 8.66   | 🟢 +0.09 | 🟢 +0.07 | 🟢 +0.02 | 🟢 +0.02 | 🟢 +0.01 | 🟢 +0
View metric targets Metric | Range | Ideal score --- | --- | --- Flesch Reading Ease | 100 (very easy read) to 0 (extremely difficult read) | 60 Gunning Fog | 6 (very easy read) to 17 (extremely difficult read) | 8 or less Auto. Read. Index | 6 (very easy read) to 14 (extremely difficult read) | 8 or less Coleman Liau Index | 6 (very easy read) to 17 (extremely difficult read) | 8 or less Dale-Chall Readability | 4.9 (very easy read) to 9.9 (extremely difficult read) | 6.9 or less
freakwriter commented 3 weeks ago

@StarfallProjects as discussed, I've created a subdirectory and split the h2s out into individual pages. Let me know what you think.

I briefly toyed around with manually adding HTML to achieve something similar to the data transformation functions, but quickly realized that was likely going to be more work than using the .yaml file and plugin, so I backed out those changes. I went back and forth on keeping the programmatic-style execute method as its own page, since the programmatic-style parameters is a pretty small page to begin with. Let me know if you think it would be better to collapse into a single page.

I wasn't 100% certain what metadata to use at the top of each page; I used a couple other pages for reference and did my best, but please review that especially.

I don't think a redirect for the removed single-page is necessary, since the URL ends up being the URL for the subdirectory itself, which feels correct, but let me know if I made any faulty assumptions there.