✨ The Gladys documentation is evolving: discover what's new!

Hello everyone!

This morning, I worked on several improvements to the Gladys documentation to make it clearer and more accessible.

:pushpin: Simplified navigation

There is now a clear list of the different ways to install Gladys:

On the « Get Started » page, I detail each installation method and the recommended hardware:

:desktop_computer: New tutorial: Install Gladys Assistant on a mini-PC

Since mini-PCs are now the recommended solution for installing Gladys, I’ve highlighted a new dedicated tutorial:

The video comes from the Gladys training. I decided to extract it to showcase the quality of the content offered. :movie_camera:

:pushpin: Discover it here:
:backhand_index_pointing_right: Install Gladys on a mini-PC

:spouting_whale: Improved Docker/Docker Compose installation documentation

The Docker/Docker Compose tutorials have been updated to better reflect the reality of an installation in 2025.

:globe_showing_europe_africa: More international documentation

The homepage and all the installation documentation in English are now designed for an international audience, with a particular focus on the United States.

I also migrated all links to Amazon US, and removed references specific to France (e.g., Freebox Delta).

:speech_balloon: Your feedback?

If you find that some parts of the documentation lack clarity, let me know!

I’m open to concrete feedback, especially from beginners who have trouble getting started with Gladys. Your opinions are valuable to continue improving the user experience. :smiley:

See you soon!

6 Likes

That’s clearer. Great to have added a disclaimer for the Raspberry Pi. It’s true that, in terms of value for money, it’s better.

1 Like

Indeed, it’s much clearer.
Just a small detail.
In the menu
Gladys Plus appears at the bottom of my browser page.

When I clicked on it, I didn’t immediately notice that the arrow next to it had pointed down.
![Capture d’écran de

@bjm The scrollbar appears automatically at the moment of the click, so the user sees that there is an element below.

Adding an element below won’t change anything, the same effect will occur.

Honestly, I don’t think there’s a real problem. The site uses Docusaurus, an open-source platform widely adopted by thousands of sites. It’s not an internally developed tool, so I don’t have control over this behavior. :slightly_smiling_face:

hi @pierre-gilles, I’m revisiting the docs and I have an existential question: who is your audience?
I mean: you start with the formal « vous », then switch to the informal « tu », then back to « vous », etc.
The goal would be to harmonize and use either « vous » or « tu » consistently.
So I’m old-school and on a website I clearly prefer the formal « vous » (even though in real life I tend to use « tu » pretty quickly).
There you go, that was tonight’s question :blush:

Quick note about choosing the home automation box: I’d put the beelink Gladys offer first (rather than at the end), before Amazon, and indicate that purchasing via Gladys helps support and advance the project (even if there’s an affiliation with Amazon).
EDIT: I just visited the Installation on mini-PC page and you do highlight the Gladys offer nicely :ok_hand:

2 Likes

Users like you! :slight_smile:

Good point! Since there have been several authors (and a bit of AI here and there), the harmonization isn’t always perfect. I’ll take a look.

Using ‹ vous › gives a more « pro » feel, but it also creates distance and can give the impression that Gladys is run by a large team, whereas it’s a modest, human-scale open-source project.

Using ‹ tu ›, on the other hand, is more friendly, but can seem less formal.

Personally, I prefer ‹ tu ›, so I’ll reread and see what feels most natural to me! :slight_smile:

It’s always a balance to find: in open-source, many users don’t like it when something seems too « commercial ».

My idea here was first to explain which platforms are best for running Gladys, before mentioning my offer, without giving the impression of being pushy. But that’s a good point; I’ll see if I can present it better!

1 Like

Added a new video to the tutorial: [Install Gladys Assistant on a Mini-PC](Commencer avec Gladys | Gladys Assistant

1 Like

Hi @pierre-gilles
I have Node-Red installed on a Docker external to Gladys.
I had to go back and watch your video.
In the docs you only talk about Node-Red integrated with Gladys.
It seems to me you could add at the end of the page « As a supplement for those who have or want to install Node-Red outside Gladys the link to the blog video »
Intégrer Node-RED avec Gladys Assistant en MQTT | Gladys Assistant

Another remark, if you could add a « search » feature to the site, that would be nice.

I guess you’re talking about this documentation?

Indeed, it was written by the person who developed the internal Node-RED integration for Gladys, so it only covers the integration.

I just made a PR to add that:

Good idea, I need to investigate what is possible with Docusaurus :slight_smile:

Hi @pierre-gilles,

the link to the Google Cast documentation is broken when you try to access it from Gladys on the integration page.

Hi @Nagromdark !

Good catch, it’s my fault — I had completely forgotten to write the documentation :smiley:

It’s fixed, the link is now correct :white_check_mark:

New tutorial :

I requested an API key from Algolia this afternoon — and voilà, search is live on the site :white_check_mark:

Available across the entire site (Documentation, blog, etc…).

The site is crawled every 7 days!

7 Likes

So awesome!

1 Like

Good evening @bjm
In the

The video by @pierre-gilles on installing Node-Red is very well made.
apart from adding the command
sudo chown -R 1000:1000 /var/lib/node-red
that you gave in your post Rflink, Node Red et Gladys - #77 par Psoy for those who are on mini PCs.
and adding
-v /home/pi/.ssh/id_rsa:/home/node-red/.ssh/id_rsa:ro \\
For those who, like me, want to use their SSH key to control another device via SSH from Gladys with node-red-contrib-ssh-v3.
In my opinion there’s no need to reinvent the wheel, unless you want to go further later in explaining how to use Node-Red.

Good evening @bjm
I thought you wanted to redo a special Node-RED tutorial, my bad. :wink:

Following your feedback, I harmonized the documentation :slightly_smiling_face:

After a few tests, I agree: in this context, using the formal address (vouvoiement) gives a more serious and credible tone.

I updated the following articles:

Feel free to report other inconsistencies, my goal is to have documentation that is as clear and pleasant as possible!

The GitHub PR:

4 Likes

Hello everyone,

I’ve added new tutorials to the documentation, notably around dashboards, and updated several existing articles to make them clearer and up to date :grinning_face_with_smiling_eyes:

:tada: New articles:

:sponge: Updated articles:

All these changes are also available in the English version of the documentation!

Enjoy reading and don’t hesitate to give me feedback :folded_hands:

5 Likes