Commit Graph

26 Commits

Author SHA1 Message Date
Leena Miettinen
3bb3fbd698 Doc: Add Python Window UI tutorial to the sidebar TOC
Change-Id: I7550d0e388d08e5ded3baa2d87089f98d6c3b62f
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-18 06:23:14 +00:00
Leena Miettinen
f75821fe99 Doc: Update tutorial names also in sidebar TOC
Change-Id: I4532ef5bbaeee8852dac6b0d9c52ae26d0cc1e32
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-15 10:51:04 +00:00
Leena Miettinen
4e40c6b2b4 Doc: Add documentation for the SDK Tool
Task-number: QTCREATORBUG-31082
Change-Id: I0d81240805bb2d0ae9c5bb8f9a42be7af90c6d69
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
2024-07-15 08:33:20 +00:00
Leena Miettinen
93fcd753c8 Doc: Fix navigation
- Add "User Interface" and "Configuring Qt Creator" to the TOC
- Fix a \previouspage link to point to the How To topic
- Arrange Reference topic categories in alphabetic order

Change-Id: I674db28d089f5dd13a0bd16d34682fff8887b8ee
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-10 09:16:51 +00:00
Leena Miettinen
bcd3491fd9 Doc: Update front page and getting started page
Apply new design and images from the UX team.

Task-number: QTCREATORBUG-30248
Change-Id: I202288f0dccedc65e47cd8bdfa49915d47cd79cd
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-04 10:48:11 +00:00
Leena Miettinen
b4d345db2a Doc: Restructure "Building Applications for the Web"
Remove the requirements and link to Qt for WebAssembly docs.

Task-number: QTCREATORBUG-29361
Change-Id: I73b708953834fa0b239805c0ea10232c3fa440f5
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2024-05-29 09:54:31 +00:00
Leena Miettinen
5b94de6308 Doc: Turn QML preview topics in to how-to topics in Qt Creator docs
- Move qt-quick-live-preview.qdoc to QDS sources
- Copy qt-quick-live-preview-desktop.qdoc to QDS sources as
  how-to\qtdesignstudio-live-preview-desktop.qdoc and remove
  Qt Creator-specific information from it
- Remove the "Running on Devices" and "Using SCXML State Machines"
  topics, which are not used any more
- Edit for style

Task-number: QTCREATORBUG-29361
Change-Id: I1646505aff8659605b09735da515e5d21070d39e
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Pranta Ghosh Dastider <pranta.dastider@qt.io>
2024-05-03 12:31:41 +00:00
Eike Ziller
0f4efacb91 Merge remote-tracking branch 'origin/13.0'
Conflicts:
	doc/qtcreator/src/overview/creator-only/creator-reference.qdoc
	doc/qtcreator/src/qtcreator-toc.qdoc

Change-Id: Ibea5488fda972321c448c64fad7f657e84d62cdb
2024-04-30 14:23:09 +02:00
Leena Miettinen
2275b43cc4 Doc: Update info on Qt for MCUs
Task-number: QTCREATORBUG-29361
Change-Id: I926e09748265ca123fd1a52838da1d05de7f7766
Reviewed-by: Esa Törmänen <esa.tormanen@qt.io>
Reviewed-by: Yasser Grimes <yasser.grimes@qt.io>
Reviewed-by: Rainer Keller <Rainer.Keller@qt.io>
2024-04-30 11:27:02 +00:00
Leena Miettinen
bdada3c5ff Doc: Move Debugging info into "How To" and "Reference"
- Turn "Debugging" into an overview topic
- Remove FSF GDB as it is not supported anymore

Task-number: QTCREATORBUG-29361
Change-Id: I1d8ce78a2f89a85a1337d83aa6011f06afac4e41
Reviewed-by: David Schulz <david.schulz@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: hjk <hjk@qt.io>
2024-04-19 12:48:39 +00:00
Leena Miettinen
b27be7e2bf Doc: Move deployment info to Reference
Task-number: QTCREATORBUG-29361
Change-Id: Ibabac3192c3f2c1aa7ae5594ed6f5f3a915d774c
Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
Reviewed-by: Jarno Lämsä <jarno.lamsa@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Tommi Mänttäri <tommi.manttari@qt.io>
2024-04-19 08:28:09 +00:00
Leena Miettinen
e43c8c178d Doc: Split up "Using Squish" into how-to and reference topics
- Move general information to "Developing with Qt Creator"

Task-number: QTCREATORBUG-29361
Change-Id: Ia630346c6fc4e158215e1af77f4579f2a513a937
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2024-04-10 06:36:31 +00:00
Leena Miettinen
5f4a8d3130 Doc: Update the online sidebar TOC
- Fix a link
- Add Reference categories
- Move Version Control Systems up in the TOC

Change-Id: I6b6f9562c581ce8b78503d7e70ce132a0e9253a7
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-03-26 10:11:03 +00:00
Leena Miettinen
e31942fb23 Doc: Organize the front page into four columns
Lots of the information from the first column will still
move into the How To and Reference sections in future releases.

- Remove obsolete sub-TOC topics.
- Rename the "Overview" as "Developing with Qt Creator" and place it
  first in the TOC.

Task-number: QTCREATORBUG-29361
Change-Id: I8af0460b2391f3152606e5326bb7e8f630f64531
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2024-03-22 12:54:45 +00:00
Leena Miettinen
78f3dfad87 Doc: Make the \page value consistent with that for other tutorials
Fix the link in the TOC sidebar online.

Change-Id: I4522c7b65be6498797e5945f3e9c6dc4b4f3966b
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-03-21 12:00:12 +00:00
Leena Miettinen
4fa5422026 Doc: List Tutorials as a separate category on the front page
Add the following topics to the creator-tutorials group:

- Building and Running an Example
- Debugging a C++ Example Application

Task-number: QTCREATORBUG-29361
Change-Id: Ib6de92e99caf552ee8337b49af48bd04d6760474
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-14 15:17:06 +00:00
Leena Miettinen
17f40221e0 Doc: Update the online doc sidebar according to structure changes
Some of the linked topics were removed and others are now how-to
topics. Added How To and Reference categories and fixed topic titles.

Task-number: QTCREATORBUG-29361
Change-Id: I96efb10baacc173c30c6d568589bc91b3ff381ee
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-11 10:53:45 +00:00
Leena Miettinen
158058ca3b Doc: Reorganize the "Designing UIs" section
- Create how-to and reference topics.
- Move the short descriptions of topics to "IDE Overview".

Task-number: QTCREATORBUG-29361
Change-Id: I11a334de6151350ce993e4135828a3eecaabf308
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-01-05 13:35:43 +00:00
Leena Miettinen
aa9206ca81 Doc: Describe CMake profiling
Task-number: QTCREATORBUG-29392
Change-Id: I661d6d39148a53daf328b4895d8cd7cabf163d7a
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-11-02 10:00:19 +00:00
Leena Miettinen
bd38c30759 Doc: Reorganize info on kits
Divide current topics into how-to and reference topics.

Task-number: QTCREATORBUG-29361
Change-Id: I0e64b2bbe9d4f6d403815dffe937a567eb9d4844
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-09-22 06:35:32 +00:00
Leena Miettinen
6cf4b1a3cd Doc: Use hyphenated form of "command-line" where appropriate
That is where it precedes another noun, such as "options",
"arguments", or "tools".

Change-Id: Ic4c339084e7350fe737e499293a8f96c91c57fd7
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-09-13 10:12:26 +00:00
Leena Miettinen
097cb17af4 Doc: Replace "Getting Help" with "How To"
Move the topics to either "How To: Read Qt documentation" or
"Reference", depending on their type.

Task-number: QTCREATORBUG-29361
Change-Id: Ifa46192f7a15a71e8d3454010f6b96764776f82b
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-09-13 06:56:53 +00:00
Leena Miettinen
31386c3fa0 Doc: Add a Reference topic
For listing reference topics.

Task-number: QTCREATORBUG-29361
Change-Id: I1d0463c4bfcd826464535a377da533509d838435
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-07-11 07:58:51 +00:00
Leena Miettinen
2d91be25f2 Doc: Try to make All Topics more visible
And provide some tips for searching.

Task-number: QTCREATORBUG-28996
Change-Id: I35d611326555ccc568c98c49e092380d206fce6b
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-04-26 12:21:38 +00:00
Leena Miettinen
0e063ecfca Doc: Add second level to online sidebar TOC
Change-Id: I55e36278ff907e6625f49b4987e2786b8e5f7f97
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-12-22 10:14:17 +00:00
Leena Miettinen
5fc456dd22 Doc: Rearrange files in the doc folder
Source and configuration files for each manual are now located in a
separate subdirectory, with common configuration files in doc/config.

doc
|_config
|_qtcreator
|_qtcreatordev
|_qtdesignstudio

Edit the config files accordingly.

Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-27 09:05:07 +00:00