Docs/style: Reformatting the Docs#485
Open
MithraGhlm wants to merge 1 commit into
Open
Conversation
Member
|
This PR contains all commits from #482, could you untangle this? |
Contributor
Author
Oh, bad mistake! Sorry |
Contributor
Author
|
For this task we need to have a base guiding rule, so everyone who writes a piece of documentations follows them. |
SprGrf
reviewed
May 20, 2026
Comment on lines
+73
to
+78
| <div style={{ display: "flex", justifyContent: "center" }}> | ||
| <video autoPlay loop muted playsInline style={{ maxWidth: "100%", borderRadius: "8px" }}> | ||
| <source src={orbbecNewApp} type="video/webm" /> | ||
| Creating a new Orbbec Camera component. | ||
| </video> | ||
| </div> |
Contributor
There was a problem hiding this comment.
I think that was for the image to be inline with the numbered list.
|
|
||
| Starting with driver version `collections/fanuc:v1.1.0` and robot controller software V9.40/P85, it is possible to read | ||
| force torque sensor values directly from the robot. The type of force sensor can be configured through the `force_sensor_type` | ||
| Starting with driver version `collections/fanuc:v1.1.0` and robot controller software V9.40/P85, it is possible to read force torque sensor values directly from the robot. The type of force sensor can be configured through the `force_sensor_type` |
Contributor
There was a problem hiding this comment.
The formatting might be off here.
| Creating a new RealSense Camera component. | ||
| </video> | ||
| </div> | ||
| <div style={{ display: "flex", justifyContent: "center" }}> |
Member
That is welcome. Could you please state here what guidelines were introduced? |
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.
Description
The existing documentation, while well written, does not follow a consistent formatting style. To improve the overall coherence and presentation of the documentation, we agreed to introduce a set of basic formatting guidelines after discussions with @eeberhard and @SprGrf.
This PR starts the reformatting effort and applies the new conventions across several documentation files.
Review guidelines
Estimated Time of Review: 5 minutes
Checklist before merging: