Closed ayatnkw closed 1 day ago
Name | Link |
---|---|
Latest commit | 216f80ae3cbb1056a0546ed9b32d92f5c095e795 |
Latest deploy log | https://app.netlify.com/sites/n8n-docs/deploys/66e0aad694049a0008f1f055 |
Deploy Preview | https://deploy-preview-2333--n8n-docs.netlify.app |
Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
Overall readability score: 43.8 (🟢 +0.06)
File | Readability |
---|---|
node-options.md | 72.33 (-) |
document-operations.md | 61.58 (-) |
index.md | 61.2 (-) |
sheet-operations.md | 85.16 (-) |
@ayatnkw Options are handled somewhat inconsistently across nodes. Things I like about your table approach:
One of the advantages to the table could be splitting out the description of what the option's used for from the actual options you can choose from and/or having some kind of "Related resources" section that could contain the links to relevant external docs. I might try playing around with that to see if we can make the table do even more than it's currently doing, something like:
| Option | Description | Configuration | Related resources |
To me, that takes it from just a change of presentation to one of really making the most of the format change to convey more information faster, so the format does more for us. Do you want to try that? Should I try adding a suggested commit to show what I'm thinking in more detail?
Wouldn't we move the operation details to a different page here as well? Just like we did with Telegram?
That would probably have a few advantages:
In any case, I think I slightly prefer the table since it feels a little cleaner. But I think we should always have sub-pages for the operation details.
I hadn't looked at the overall length here, but I suspect Nik's suggestion is a good one, to play around with the subpage layout for Document vs. Sheet Within a Document operations...that might give us some more visual space to work with and then having the subheading for Options isn't going to feel as overwhelming. @ayatnkw maybe this would be a good one for us to work together on to play around with that, and then we can see if this number of operations feels like it's close to the cutoff for having the subpage format??
Thanks for the comments, I'll put the operation details in separate pages and play around with the table formatting.
One thing I'm uncertain about with the table formatting is how well the AI assistant will read it. I'm also not so sure about having too many columns because of the limited width on the docs page (I'd say max 3 columns) I'll play around a bit and maybe @freakwriter and I can talk about it on Monday.
@nik8n @freakwriter made suggested changes, would be great if you could take another look!
Looks good to me. Two pieces of feedback:
Append an Array
I would mention the AI transform node and the split out node, no? Both of these options seem much easier than using a code node. And maybe we also want to get a little more into detail here and provide examples or a how-to? (kinda like the cookbook pages we sometimes have)@nik8n I've incorporated some of my own edits plus added the nodes you mentioned. A more detailed set of examples/cookbook would likely be good long-term, but in the interests of trying to get some changes out the door, I've just provided brief summaries for now. Let me know what you think.
Changes