Skip to content
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

The affiliation of the catalog of books #2021

Closed
mengchaoheng opened this issue Aug 29, 2022 · 8 comments · Fixed by #2541
Closed

The affiliation of the catalog of books #2021

mengchaoheng opened this issue Aug 29, 2022 · 8 comments · Fixed by #2541

Comments

@mengchaoheng
Copy link

Why do the titles of this guide, including chapter and section titles, not explicitly indicate affiliation? The cluttered entries make it difficult for readers to read. Should this be a bad habit of programmers? ?

@hamishwillee
Copy link
Collaborator

I have no idea what you are suggesting.

@mengchaoheng
Copy link
Author

I have no idea what you are suggesting.

@hamishwillee When we read a book, the title is like this: it contains 1, 2 chapters, each chapter also has 1.1, 1.2 and so on. We can clearly see the structure of the whole book. I found the PX4's guide very confusing at this point. I have no idea which heading each section belongs to! ! !
For example: What is the relationship between "Homebrew Installation" and "Enforce Python Version" and "Common Tools", parallel or subordinate relationship?

image

@mengchaoheng
Copy link
Author

mengchaoheng commented Aug 29, 2022

in RTPS/DDS Interface: PX4-Fast RTPS(DDS) Bridge, what is the relationship between “Code generation“ , ”Fast RTPS(DDS) Applications (ROS Independent)“, ”Supported uORB messages“, “Client (PX4/PX4-Autopilot)”, “Agent in an Offboard Fast DDS interface (ROS-independent)”, “Creating a Fast DDS Listener application”, and so on. @hamishwillee

@mengchaoheng
Copy link
Author

I have no idea what you are suggesting.

I suggest reorganizing the title and table of contents of the guide. @hamishwillee

@hamishwillee
Copy link
Collaborator

OK, so the problem with http://docs.px4.io/main/en/dev_setup/dev_env_mac.html is that it does not have proper structure. Adding section information would not fix this. I will improve that document in a few days.

For https://docs.px4.io/main/en/middleware/micrortps.html the relationships are conveyed by the size of the headings as is common in HTML. Those seem very clear to me without numbering.

@mengchaoheng
Copy link
Author

好的,所以http://docs.px4.io/main/en/dev_setup/dev_env_mac.html的问题是它**没有适当的结构**。添加部分信息不会解决此问题。我将在几天内改进该文件。

对于https://docs.px4.io/main/en/middleware/micrortps.html,关系通过标题的大小来传达,这在 HTML 中很常见。这些对我来说似乎很清楚,无需编号。

Expressing relationships by title size is bullshit. You can see with the naked eye that the size of the title does not mean that other readers can. Eye disease patients with size judgment disorders will be confused by this. Please use traditional article organization instead of size. In addition, it is still difficult to discern when the difference in title size is subtle. @hamishwillee

@mengchaoheng
Copy link
Author

error

$ git clone --recursive https://github.com/eProsima/Fast-DDS.git -b v2.0.2 ~/FastDDS-2.0.2
$ cd ~/FastDDS-2.0.2
$ mkdir build && cd build
If you are on Linux, execute:

$ cmake -DTHIRDPARTY=ON -DSECURITY=ON ..
$ make -j$(nproc --all)

just fix by :

 git clone https://github.com/eProsima/Fast-DDS.git
git checkout v2.0.2
 git submodule update --init --recursive 

@hamishwillee
Copy link
Collaborator

hamishwillee commented May 24, 2023

The latest docs do not directly install this component and won't for PX4 v1.14 - so "fixed by waiting". I have tidied up the mac page so it is now less poorly structured.

The heading numbering is a "nice to have". I'm looking at updating the infrastructure again, and might add a setting to enable this for those who need it. That could be tracked in #2542

So closing as "done" or handled in other issues now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants