@Stiltjack
I know it’s a group thing, and I have no problem pulling levers on links, but I thought the top description of the cookbook page needs help. When you reference the link, it pulls in a paragraph un-formatted with the beginning of the links. There is the lead sentence, then it starts with the links that get jumbled.
My thought is someone good with words such as yourself could make the paragraph longer so that it is a better explanation when you hand someone the link to the cookbook itself…
Looks like this here:
And looks like this everywhere else:
So filling in a longer paragraph at the top with a longer excerpt would help overall.
If someone else wants to take a shot, fine with me as well. It just needs help.
It’s fine original.
Look at the pictures of external links…
If we add to the first line an excerpt, the explanation shown on external links will be more presentable.
I’m enjoying the cookbook since it gives me a lot of good ideas on what I can do with home assistant and it jumpstarts many projects.
My contribution to the home assistant community is writing and updating guides. Two of them made it to the cookbook so far.
What is still missing?
Maybe we can use this topic to gather and vote on suggestions.
I hope this inspires others to help with writing good and complete documentation.
Heads up with editing the Cookbook.
It appears Discourse had a limit on how many of the auto-title links in a post. You know, the ones where you drop the link and add a “.” at the end so it displays pretty…
The cookbook is at the limit, so every new link added should use the
[link display](link)
nomenclature going forward.
Otherwise you add your link then someone has to come around and fix the oldest link that is now displaying the URL instead of the pretty words…
It’s happened to me a few times and I have fixed it already when others have added links, so be aware.
I hope they’re going to upgrade the forum soon. My weather integration guide is uneditable because changes to tables can duplicate part of the code. These inconveniences and restrictions cost a lot if time and withhold (newer) users from contributing.
Fix what, changing the Discourse page generation code?
We just need to use the html code because there is a limit on how many they do for us. This would not be a configuration parameter, rather just how it’s coded.
I could fix it now by editing the doc and converting a bunch then people could add new links for a while the easy way, but people adding links can just as easily code it when they put in new ones. Someone added one a couple of days ago and it went well for them.
So I get alphabetical, etc…
The big problem is that I have given out quite a few links to the zigbee section and now you have broken all those links. The Zigbee link is now different as Discourse adds a number on the end to keep the links unique within the document, even if the heading words are the same. The number is a count from the top of the document.
instead of 18, zigbee is now 20…
We have to think about adding sections and re-arranging sections for the sake of re-arranging them, these actions have a ripple effect…
It’s probably been broken before and I didn’t notice it, and I’ll get over it, but another thing to think about…
