improvement switch to new docs as code #2453
Conversation
RolandJentschETAS
requested review from
a team,
AlexanderLanin,
FScholPer,
MaximilianSoerenPollak,
antonkri,
dcalavrezo-qorix,
johannes-esr and
qor-lb
as code owners
|
|
|
The created documentation from the pull request is available at: docu-html |
MaximilianSoerenPollak
left a comment
MaximilianSoerenPollak
left a comment
There was a problem hiding this comment.
Some comments regarding options
MaximilianSoerenPollak
left a comment
MaximilianSoerenPollak
left a comment
There was a problem hiding this comment.
Just this last thing that I saw / noticed.
Other than that looks good to me, thanks for the addition.
docs/modules/lifecycle/index.rst
Outdated
| :status: valid | ||
| :safety: ASIL_B | ||
| :security: NO | ||
| :includes: logic_arc_int__lifecycle__controlif, logic_arc_int__lifecycle__alive_if |
There was a problem hiding this comment.
Docs-as-code as well as process currently state that 'comp_arc_sta' can only have 'comp' and 'comp_arc_sta' inside of the includes attribute
The build still succeeds as currently optional links are not checked / enforced to be correct.
Though this will stop working once that is enforced.
I guess uses or implements or fulfils are allowed to have 'logic_...' needs linked inside of it.
There was a problem hiding this comment.
You are right. I'm not sure if that is intended ore an fault of the process and docs as code as well.
If components are structured internally into (sub)components, then it should be identically to the feat via the interfaces of the sub components. Will discuss this in the process community.
Currently the draw function for components works exactly in this way with the interfaces.
There was a problem hiding this comment.
Might be something that should be brought up in the Process meeting then
There was a problem hiding this comment.
Yes. I have done it. Until, I have removed the interfaces. Makes no sense anyway because of there is no internal substructuring defined.
MaximilianSoerenPollak
left a comment
MaximilianSoerenPollak
left a comment
There was a problem hiding this comment.
Seems good as far as I can tell.
Thanks.
3 participants
Switch lifecycle to new docs as code version