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

Overview page updates #19

Merged
merged 6 commits into from
Jul 9, 2024
Merged

Overview page updates #19

merged 6 commits into from
Jul 9, 2024

Conversation

JMoore5353
Copy link
Contributor

The organization of the User Guide section felt a little confusing to me, so I refactored it a little bit. Let me know what you think.

I added a ROSplane overview page in the User Guide, since we had no real landing page that described what ROSplane was. On this same note, I added a ROSplane overview to the developer guide, since we didn't have a landing page there. The idea with these landing pages is that it helps people who visit the site know where to start and organizes the rest of the sections they are a part of.

@JMoore5353 JMoore5353 self-assigned this Jun 25, 2024
@bsutherland333
Copy link
Contributor

I agree that the organization is a bit confusing, having different sections for ROSflight, ROSplane, and ROScopter is a good idea. I don't know if I love calling the ROSflight section "Fly with ROSflight" though, what if we just called it "ROSflight" and then made sure the user guide overview is very clear about the roles ROSflight, ROSplane, and ROScopter?

@JMoore5353
Copy link
Contributor Author

JMoore5353 commented Jun 27, 2024

I agree that the organization is a bit confusing, having different sections for ROSflight, ROSplane, and ROScopter is a good idea. I don't know if I love calling the ROSflight section "Fly with ROSflight" though, what if we just called it "ROSflight" and then made sure the user guide overview is very clear about the roles ROSflight, ROSplane, and ROScopter?

That makes sense. I updated that to ROSflight and refactored some of the information I felt like belonged in other sections to those sections (RC -> RC page, LEDs -> board page). That way the text just describes the main components of ROSflight as seen in the figure, and also links to more information.

How do you guys feel about the tldr at the top? :) The goal is to make it as clear as possible where people need to get started... I keep visiting research project sites that have no explanation of what they are / what is going on with the software, so I'd like that to be clear here.

@JMoore5353 JMoore5353 marked this pull request as draft June 27, 2024 16:44
@JMoore5353 JMoore5353 marked this pull request as ready for review June 27, 2024 16:57
@JMoore5353 JMoore5353 linked an issue Jun 27, 2024 that may be closed by this pull request
@iandareid iandareid merged commit f3dbf93 into main Jul 9, 2024
1 check passed
@iandareid iandareid deleted the overview-page-updates branch July 9, 2024 20:07
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 this pull request may close these issues.

ROSplane setup page and developer guide
3 participants