Reading the documentation is exciting! So often, I get new ideas and updates to old ones.
I still have not located the root link to the many categories in the documentation(s)… I stumbled across Integrations - Home Assistant by accident one day and have been partially educated at the expense of sitting at a live terminal vs enjoying the benefits of my HA from my easy chair reading a selected PDF printout. Also, I do not have the luxury of a printed reference note while I am drafting my YAML code chunks.
My difficulty is you must be on line to read them.
– My Suggestion is to link ability to create a PDF. That way I could print and do my reading off line.
Also, I do understand everything including the provide documentation and examples are as fluid as the version release itself. Wouldn’t it be helpful to everyone if the documentation had the noted version release or revision date so that you could tell it contained updates or what release was current when it was written?
example this morning I was reading what was included in the latest update. OMG, so exciting, everything I could ask for , I hit the install and now the read is completely gone and I don’t know how to find all the details it contained…
Another great benefit of PDF in the easy chair… My highlighter! so that the next visit to the computer interface, I can make the changes and stay current.
I’d be in favor of any procedural change to improve documentation. But on a project like this, it’s never going to get top priority. Coding is fun. Writing documentation isn’t. HA coders are mostly volunteers, doing this for fun.
But if it’s any help, there’s a “documentation” link right at the top of the HA home page. Of course any page can be saved as or “printed to” PDF for offline reference. You can highlight lines in a PDF, with the right software.
As for finding things, I have the most luck using the site: option in DuckDuckGo (or Google, if you prefer.) For example, the search would be “site:home-assistant.io/ integrations” or whatever you’re searching for. This will bring up not only the documentation, but anything from this forum which contains your search terms.
I found this thread thinking about this from another angle.
Now that so many of us are starting to run local AI and explore how we can integrate it with Home Assistant, I find myself looking for suitable training material for my local LLM.
It would be brilliant to have some kind of offline dump file of the docs that can be used as an AI training set. So when I’m trying to figure out something in HA, I can literally have a conversation with the docs to worth through it.
Using RAG, it’s easy enough to update the doc file once a month or so in the vector database, if there were a doc file.
this is exactly the use case that brought me to this post. I think it would be amazing to have a file that I could add to a RAG to assist with creating automations, scripts, and dashboards.
Hi ,
I reach this post for the same reason of some guys, get material to use with AI.
So, I did what I already done for other products/softwares, asked the AI to create a Python code to scrape the documentation and create a unique Markdown file. (when is PDF files, to attach all of them together).
I’m using Gemini Plus, which is VERY limited to add files to they GEM knowledge database, only 10 files.
Asking to Gemini how is better to work with it, says that is put all together in one file.
So, that is what I’m doing… appears to works until now..
Appears to be possible to convert this MarkDown file to PDF .
Need to use few tools to convert it to HTML and then to PDF.
However the links, I think will be broken…
Who need PDF version can try that… (not my case)
, I hit the install and now the read is completely gone and I don’t know how to find all the details it contained…
from me.