doc: develop: west: Update documentation for v1.4.0 #90044
Conversation
pdgendt
commented
May 16, 2025
pdgendt
commented
- Add release notes for v1.3.0 and v1.4.0
- Updated the API for v1.4.0
pdgendt
force-pushed
the
west-docs
branch
2 times, most recently
from
59b8928 to
28f1934
Compare
Add release notes for v1.3.0 and v1.4.0. Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
Update the west API documentation for the added active_only arguments to as_dict/as_frozen_dict/as_yaml/as_frozen_yaml. Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
|
marc-hb
left a comment
marc-hb
left a comment
There was a problem hiding this comment.
The content is fine but do we really need to keep duplicating this to the wrong git repo? I wonder why the 1.3.0 release notes were missed! (not)
Moving the entire West documentation is a challenge (discussed in zephyrproject-rtos/west#799).
On the other hand, merely replacing the duplicate at
https://docs.zephyrproject.org/latest/develop/west/release-notes.html with a pointer to the original at https://github.com/zephyrproject-rtos/west/releases sounds like a small de-duplication effort and I don't think the extra click will bother any user. On the contrary, users will enjoy the de-duplication, the up-to-date notes and the better hypertext.
I agree, but didn't want to change the process for this minor release.
I still think it would be better to have a dedicated documentation site for west, but this would be something for west v2.
This was somewhat discussed with @mbolivar in discord, where I suggest to move large chunks and keep the Zephyr specifics in the Zephyr documentation. |
How much of a "process" change would this de-duplication be? It looks trivial to me but I might miss stuff. |
Probably trivial, but the effort is already done, I don't see an issue with doing this still for v1.4.0. I'll work on this after the release if that's okay. |
4 participants
