Docs/style: Reformatting the Docs#485
Conversation
|
This PR contains all commits from #482, could you untangle this? |
Oh, bad mistake! Sorry |
|
For this task we need to have a base guiding rule, so everyone who writes a piece of documentations follows them. |
| <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> |
There was a problem hiding this comment.
I think that was for the image to be inline with the numbered list.
There was a problem hiding this comment.
I'll revert it. The extension did it.
There was a problem hiding this comment.
As I see in the original page of this file, the first image is a tab to the left compared to the other 2 images after it. Is this intentional and should I have kept it that way?
Should pictures be pushed to the right or to the left?
|
|
||
| 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` |
There was a problem hiding this comment.
The formatting might be off here.
There was a problem hiding this comment.
I'll update with Prettier.
update: I checked visually and didn't notice what has changed there, except for bolding the numbers. So it would be nice if we could double check it together when your back in the office.
| Creating a new RealSense Camera component. | ||
| </video> | ||
| </div> | ||
| <div style={{ display: "flex", justifyContent: "center" }}> |
That is welcome. Could you please state here what guidelines were introduced? |
3 participants
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: