diff --git a/docs/en/SUMMARY.md b/docs/en/SUMMARY.md index 13850fffe5a..0efead645c6 100644 --- a/docs/en/SUMMARY.md +++ b/docs/en/SUMMARY.md @@ -77,10 +77,11 @@ - [Getting Started with source & builds](qgc-dev-guide/getting_started/index.md) - [Build using Containers](qgc-dev-guide/getting_started/container.md) - [Using QGC on CentOS](qgc-dev-guide/getting_started/cent_os.md) + - [Navigating the Source Code](qgc-dev-guide/navigating_source.md) + - [Class Hierarchy](qgc-dev-guide/classes/index.md) - [QGC Release/Branching Process](qgc-dev-guide/release_branching_process.md) - [Communication Flow](qgc-dev-guide/communication_flow.md) - [Plugin Architecture](qgc-dev-guide/firmware_plugin.md) - - [Class Hierarchy](qgc-dev-guide/classes/index.md) - [User Interface Design](qgc-dev-guide/user_interface_design/index.md) - [Multi-Device Design Pattern](qgc-dev-guide/user_interface_design/multi_device_pattern.md) - [Font and Colour Palette](qgc-dev-guide/user_interface_design/font_palette.md) diff --git a/docs/en/qgc-dev-guide/contribute/dev_call.md b/docs/en/qgc-dev-guide/contribute/dev_call.md.save similarity index 100% rename from docs/en/qgc-dev-guide/contribute/dev_call.md rename to docs/en/qgc-dev-guide/contribute/dev_call.md.save diff --git a/docs/en/qgc-dev-guide/getting_started/cent_os.md b/docs/en/qgc-dev-guide/getting_started/cent_os.md index 7855b7efbe7..fff0c7f0f9f 100644 --- a/docs/en/qgc-dev-guide/getting_started/cent_os.md +++ b/docs/en/qgc-dev-guide/getting_started/cent_os.md @@ -1,5 +1,11 @@ # Using QGC on CentOS 7 + ::: warning + **This guide has not been updated.** + Follow the regular build instructions instead. This page is left here in case there is some other useful info which is not really QGC + specific, but OS setup related. + ::: + ## OS Installation To install CentOS 7: diff --git a/docs/en/qgc-dev-guide/navigating_source.md b/docs/en/qgc-dev-guide/navigating_source.md new file mode 100644 index 00000000000..9ca0832abeb --- /dev/null +++ b/docs/en/qgc-dev-guide/navigating_source.md @@ -0,0 +1,20 @@ +# Navigating QGC Source Code + +QGC is a large code base. With that it can be daunting to find what your are looking for in the source. Below are listed some tips to help you find what you are looking for. + +## Start from the top of the UI + +The top level window Qml UI code is found in `MainRootWindow.qml`. You can start here and work your way down through the UI hierarchy till you find what you are looking for. + +In this qml file you'll find things like: + +* How the toolbar is created +* How the top level views are created: Fly, Plan, ... + +## Global Search + +The best way to find something is to find the UI which is closest to what you are looking for by doing text searches. + +### Example: Find the source for the GPS drop down in the toolbar + +In the dropdown you see the words "Vehicle GPS Status". Do a global search for those words. Make sure you are doing a case sensitive search. Also make sure you are matching whole words. It can also be helpful to exclude the `*.ts` translation files. Since they can lead to multiple results. If you do the search described here it will take you right to `GPSIndicatorPage.qml`. Some times a search may lead to many results in both qml and .cpp files. In this case limit the results to `*.qml` files.