search

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
167 stars 320 forks source link

add doc link to frontmatter for some pages as sample #2196

Closed StarfallProjects closed 3 months ago

netlify[bot] commented 3 months ago

Deploy Preview for n8n-docs ready!

Name Link
Latest commit da95d3cf356f9e2246712fd5c3a6597f79b2ed93
Latest deploy log https://app.netlify.com/sites/n8n-docs/deploys/668276384ecd530008efb2c6
Deploy Preview https://deploy-preview-2196--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 months ago

Overall readability score: 41.16 (🟢 +0)

File Readability
1-0-migration-checklist.md 60.64 (🟢 +0)
agent-chain-comparison.md 74.28 (🟢 +0)
api-workflow-tool.md 68.83 (🟢 +0)
data-google-sheets.md 70.48 (🟢 +0)
human-fallback.md 71.91 (🟢 +0)
introduction.md 48.43 (🟢 +0)
understand-agents.md 65.5 (🟢 +0)
understand-chains.md 66.72 (🟢 +0)
understand-memory.md 51.39 (🟢 +0)
understand-tools.md 71.93 (🟢 +0)
understand-vector-databases.md 48.16 (🟢 +0)
vector-store-website.md 62.99 (🟢 +0)
index.md 46.58 (🟢 +0)
intro-tutorial.md 75.93 (🟢 +0)
choose-n8n.md 46.44 (🟢 +0)
enterprise-key.md 66.61 (🟢 +0)
external-secrets.md 49.42 (🟢 +0)
faircode-license.md 57.41 (🟢 +0)
index.md 52.84 (🟢 +0)
keyboard-shortcuts.md 84.27 (🟢 +0)
learning-path.md 57.15 (🟢 +0)
log-streaming.md 52.83 (🟢 +0)
release-notes.md 69.33 (🟢 +0)
video-courses.md 25.51 (🟢 +0)
View detailed metrics 🟢 - Shows an _increase_ in readability 🔴 - Shows a _decrease_ in readability File | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- [1-0-migration-checklist.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/1-0-migration-checklist.md "docs/1-0-migration-checklist.md") | 60.64 | 55.13 | 10.27 | 12 | 12.06 | 7.19   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [agent-chain-comparison.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/advanced-ai/examples/agent-chain-comparison.md "docs/advanced-ai/examples/agent-chain-comparison.md") | 74.28 | 66.74 | 7.97 | 8.9 | 9.44 | 7.32   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [api-workflow-tool.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/advanced-ai/examples/api-workflow-tool.md "docs/advanced-ai/examples/api-workflow-tool.md") | 68.83 | 56.25 | 8.89 | 9.3 | 9.45 | 7.8   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [data-google-sheets.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/advanced-ai/examples/data-google-sheets.md "docs/advanced-ai/examples/data-google-sheets.md") | 70.48 | 66.54 | 8.61 | 9.1 | 9.85 | 7.88   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [human-fallback.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/advanced-ai/examples/human-fallback.md "docs/advanced-ai/examples/human-fallback.md") | 71.91 | 65.73 | 8.22 | 9.2 | 9.91 | 7.53   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [introduction.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/advanced-ai/examples/introduction.md "docs/advanced-ai/examples/introduction.md") | 48.43 | 36.25 | 8.23 | 14.2 | 16.33 | 8.24   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [understand-agents.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/advanced-ai/examples/understand-agents.md "docs/advanced-ai/examples/understand-agents.md") | 65.5 | 61.06 | 11.75 | 9.2 | 8.41 | 8.06   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [understand-chains.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/advanced-ai/examples/understand-chains.md "docs/advanced-ai/examples/understand-chains.md") | 66.72 | 56.15 | 9.8 | 9.6 | 10.14 | 7.53   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [understand-memory.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/advanced-ai/examples/understand-memory.md "docs/advanced-ai/examples/understand-memory.md") | 51.39 | 32.19 | 9.23 | 13 | 14.09 | 8.1   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [understand-tools.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/advanced-ai/examples/understand-tools.md "docs/advanced-ai/examples/understand-tools.md") | 71.93 | 65.22 | 8.82 | 9.1 | 9.21 | 7.53   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [understand-vector-databases.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/advanced-ai/examples/understand-vector-databases.md "docs/advanced-ai/examples/understand-vector-databases.md") | 48.16 | 37.3 | 11.51 | 14.2 | 14.09 | 7.61   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [vector-store-website.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/advanced-ai/examples/vector-store-website.md "docs/advanced-ai/examples/vector-store-website.md") | 62.99 | 56.96 | 8.92 | 11 | 11.48 | 7.98   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [index.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/advanced-ai/index.md "docs/advanced-ai/index.md") | 46.58 | 40.85 | 9 | 14.9 | 15.77 | 8.57   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [intro-tutorial.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/advanced-ai/intro-tutorial.md "docs/advanced-ai/intro-tutorial.md") | 75.93 | 58.69 | 7.33 | 9.1 | 9.79 | 6.49   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [choose-n8n.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/choose-n8n.md "docs/choose-n8n.md") | 46.44 | 38.01 | 9.65 | 15.5 | 15.08 | 8.15   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [enterprise-key.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/enterprise-key.md "docs/enterprise-key.md") | 66.61 | 60.72 | 8.87 | 9.1 | 11.35 | 7.99   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [external-secrets.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/external-secrets.md "docs/external-secrets.md") | 49.42 | 29.45 | 9.68 | 14.9 | 15.19 | 6.99   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [faircode-license.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/faircode-license.md "docs/faircode-license.md") | 57.41 | 42.61 | 11.35 | 12.9 | 11.55 | 6.79   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [index.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/index.md "docs/index.md") | 52.84 | 43.29 | 9.55 | 12.6 | 13.84 | 8.34   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [keyboard-shortcuts.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/keyboard-shortcuts.md "docs/keyboard-shortcuts.md") | 84.27 | 72.83 | 6 | 7.8 | 8.88 | 6.32   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [learning-path.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/learning-path.md "docs/learning-path.md") | 57.15 | 43.39 | 7.9 | 13.3 | 14.36 | 7.34   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [log-streaming.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/log-streaming.md "docs/log-streaming.md") | 52.83 | 41.77 | 10.07 | 12.4 | 14.2 | 7.92   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [release-notes.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/release-notes.md "docs/release-notes.md") | 69.33 | 44.1 | 6 | 12.3 | 14.18 | 5.13   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [video-courses.md](https://github.com/n8n-io/n8n-docs/blob/da95d3cf356f9e2246712fd5c3a6597f79b2ed93/docs/video-courses.md "docs/video-courses.md") | 25.51 | 0 | 6.82 | 22 | 19 | 9.56   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 Averages:   | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- Average | 41.16 | 33.71 | 12.02 | 15.34 | 14.45 | 8.66   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +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