-
Notifications
You must be signed in to change notification settings - Fork 65
docs: fix FEO need ids #1977
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
docs: fix FEO need ids #1977
Conversation
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR replaces placeholder text component_name with the actual component name feo in FEO module documentation files, along with fixing a typo and simplifying a comment.
- Updated document IDs from placeholder
doc__component_name*todoc__feo*for consistency with existing FEO documentation - Fixed spelling error in component tag from "commponent_feo" to "component_feo"
- Updated document titles and descriptions to reference FEO Component instead of placeholders
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/modules/feo/feo/docs/index.rst | Updated document ID from placeholder doc__component_name to doc__feo |
| docs/modules/feo/feo/docs/component_classification.rst | Updated document title, ID, tags (fixed typo), and description to use FEO component name |
| docs/modules/feo/docs/safety_mgt/module_safety_plan.rst | Updated references to match new component classification document ID |
| .gitignore | Simplified comment from "docs:incremental and docs:ide_support build artifacts" to "docs build artifacts" |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
e8246b0 to
7f98714
Compare
|
The created documentation from the pull request is available at: docu-html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 4 out of 5 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
With upcoming docs-as-code 2.0.0 all IDs must be globally unique.