Update Getting Started page. #1229

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.

Sign up for GitHub

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

Jump to bottom

Merged

ewaterlander merged 1 commit into eclipse-cdt:main from ewaterlander:getting_started

Jul 17, 2025

Contributor

ewaterlander commented Jul 1, 2025

Updated the Getting Started page to the new structure that was introduced in Getting Started documentation update. #1056 .
Removed the Installing and updating the CDT page. It was very outdated and already commented out in topics_Getting_Started.xml.

Contributor Author

ewaterlander commented Jul 1, 2025

Hi @jld01
Would you like to review this change?

Contributor

jld01 commented Jul 1, 2025

Hi @jld01 Would you like to review this change?

HI @ewaterlander, good to see some work in this area. I can review, but probably next week.

jld01 approved these changes

View reviewed changes

Contributor

jld01 left a comment

Looks good, @ewaterlander. This change does highlight some inconsistency in tutorial page naming though.

doc/org.eclipse.cdt.doc.user/src/getting_started/cdt_o_tutorial.adoc Outdated

		@@ -34,16 +34,23 @@ The following tutorials guide you through the process of using the C/{cpp}
		Development Toolkit (CDT) to:

		* xref:cdt_w_prepare_workbench.adoc[Prepare the Workbench]

Contributor

jld01 Jul 10, 2025

Suggested change

      
            * xref:cdt_w_prepare_workbench.adoc[Prepare the Workbench]
          
            * xref:cdt_w_prepare_workbench.adoc[Preparing the Workbench]

Contributor Author

ewaterlander Jul 15, 2025

Done

doc/org.eclipse.cdt.doc.user/src/getting_started/cdt_o_tutorial.adoc Outdated

+              ** xref:new_cmake_proj.adoc[Creating a CMake project]
+              ** xref:new_cbs_makefile_proj.adoc[Creating a Core Build System Makefile project]
+              ** xref:cbs_using_existing_code.adoc[Using existing code]
+              ** xref:cbs_launchbar.adoc[Launch Bar]

Contributor

jld01 Jul 10, 2025

Suggested change

      
            ** xref:cbs_launchbar.adoc[Launch Bar]
          
            ** xref:cbs_launchbar.adoc[Using the Launch Bar]

Contributor Author

ewaterlander Jul 15, 2025

Done

doc/org.eclipse.cdt.doc.user/src/getting_started/cdt_o_tutorial.adoc

-              * xref:cdt_w_debug.adoc[Debug a project]
-              * xref:cdt_w_existing_code.adoc[Import C/{cpp} source into Eclipse]
-              * xref:cdt_w_install_cdt.adoc[Install/update the CDT]
+              * xref:index_cbs.adoc[Core Build System]

Contributor

jld01 Jul 10, 2025

Suggested change

      
            * xref:index_cbs.adoc[Core Build System]
          
            * xref:index_cbs.adoc[Using the Core Build System]

Contributor Author

ewaterlander Jul 15, 2025

Done

doc/org.eclipse.cdt.doc.user/src/getting_started/cdt_o_tutorial.adoc

+              ** xref:cbs_build_project.adoc[Building a project]
+              ** xref:cbs_run_project.adoc[Running a project]
+              ** xref:cbs_debug_project.adoc[Debugging a project]
+              * xref:index_mbs.adoc[Legacy Managed Build System]

Contributor

jld01 Jul 10, 2025

Suggested change

      
            * xref:index_mbs.adoc[Legacy Managed Build System]
          
            * xref:index_mbs.adoc[Using the legacy Managed Build System]

Contributor Author

ewaterlander Jul 15, 2025

This one I did not do, because it's an index page. Like index_cbs.adoc.
I did remove the " contents" suffix in the titles of index_[cm]bs.adoc.

doc/org.eclipse.cdt.doc.user/src/getting_started/cdt_o_tutorial.adoc Outdated

-              * xref:cdt_w_existing_code.adoc[Import C/{cpp} source into Eclipse]
-              * xref:cdt_w_install_cdt.adoc[Install/update the CDT]
+              * xref:index_cbs.adoc[Core Build System]
+              ** xref:core_build_system.adoc[Core Build System]

Contributor

jld01 Jul 10, 2025

Suggested change

      
            ** xref:core_build_system.adoc[Core Build System]
          
            ** xref:core_build_system.adoc[Using the Core Build System]

doc/org.eclipse.cdt.doc.user/src/getting_started/cdt_o_tutorial.adoc

Contributor

jld01 Jul 10, 2025

It would be great to adjust these bullet points to all use the same part of speech. However, this might imply changes to the title of the pages to which they point for consistency.

Contributor Author

ewaterlander Jul 15, 2025

Done


          Update Getting Started page.

fc74478

* Updated the Getting Started page to the new structure that was
  introduced in eclipse-cdt#1056 .
* Removed the Installing and updating the CDT. It was very outdated
  and already commented out in topics_Getting_Started.xml.

ewaterlander force-pushed the getting_started branch from c05c6c4 to fc74478 Compare

July 15, 2025 13:28

ewaterlander requested a review from jld01

July 15, 2025 15:12

jld01 approved these changes

View reviewed changes

Contributor

jld01 left a comment

Thanks for the changes, @ewaterlander .

ewaterlander merged commit 57df2f1 into eclipse-cdt:main

4 checks passed

ewaterlander deleted the getting_started branch

July 17, 2025 13:40

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet