docs(lifecycle): move comp_req entries into own requirements file - #3125
Open
ramceb wants to merge 1 commit into
Open
docs(lifecycle): move comp_req entries into own requirements file#3125ramceb wants to merge 1 commit into
ramceb wants to merge 1 commit into
Conversation
Split the interleaved feat_req/comp_req entries in docs/features/lifecycle/requirements/index.rst so that component requirements (comp_req) now live in their own file, component_requirements.rst, alongside the existing feature requirements file. The requirements toctree glob already picks up all files under requirements/, so no toctree changes were needed. No requirement IDs were added, removed, or modified; only their file location and grouping changed. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
ramceb
requested review from
FScholPer,
antonkri,
johannes-esr and
qor-lb
as code owners
July 27, 2026 11:53
github-project-automation
Bot
added this to
TLC - Technical Lead Circle and S-CORE Roadmap
|
The created documentation from the pull request is available at: docu-html |
aschemmel-tech
left a comment
aschemmel-tech
left a comment
Contributor
There was a problem hiding this comment.
seems we are doing parallel work: see #3123
FScholPer
requested changes
Jul 28, 2026
FScholPer
left a comment
FScholPer
left a comment
Contributor
There was a problem hiding this comment.
Should be in the module repo
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Split
docs/features/lifecycle/requirements/index.rst, which mixedfeat_reqandcomp_reqentries under the same section headings, into two files:index.rst— now contains onlyfeat_req(feature requirement) entriescomponent_requirements.rst(new) — contains onlycomp_req(component requirement) entries, grouped under the same section headingsWhy
Keeping feature and component requirements in one file made it hard to navigate. Separating them into dedicated files improves readability and matches the pattern already used by other modules (e.g.
docs/modules/feo/feo/docs/requirements/component_requirements.rst).Notes
:id:values (32 feat_req + 63 comp_req) are identical before/after, just relocated.docs/features/lifecycle/index.rstalready includes requirements via a glob (./requirements/*), so the new file is picked up automatically.