Draft
Conversation
datenreisender
added
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures the documentation by separating "Get started" content into its own folder to prepare for integration with unified documentation. The launcher-specific documentation remains in place with updated references.
Changes:
- Moved "Get started" documentation (OS support, installation, and app installation guides) to a new
doc/get_started/folder - Updated launcher documentation to reference the relocated "Get started" pages via absolute URLs
- Adjusted Zoomin configuration to differentiate between launcher and get started documentation bundles
Reviewed changes
Copilot reviewed 11 out of 20 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/launcher/zoomin/tags.yml | New Zoomin tags configuration for launcher documentation |
| doc/launcher/zoomin/custom.properties | Updated book title to specify "launcher" |
| doc/launcher/mkdocs.yml | Removed navigation entries for moved "Get started" pages |
| doc/launcher/docs/revision_history.md | New revision history file with absolute URLs to relocated pages |
| doc/launcher/docs/overview_cfd.md | Updated internal references to use absolute URLs for relocated pages |
| doc/launcher/docs/index.md | Updated internal references to use absolute URLs for relocated pages |
| doc/get_started/zoomin/custom.properties | New Zoomin configuration for "Get started" documentation |
| doc/get_started/mkdocs.yml | New MkDocs configuration for "Get started" documentation |
| doc/get_started/docs/installing_apps.md | Updated references to use absolute URLs to launcher documentation |
| doc/get_started/docs/download_cfd.md | Updated references to use absolute URLs to launcher documentation |
| doc/docs/revision_history.md | Removed file (moved to launcher folder) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Because in swtools-app-docs we want to have two separate sections.
Because the docs are split into ”Get started” and ”Launcher”, links between the two now need to be fully qualified. This enabled the unified documentation in swtools-app-docs to turn these into proper relative links again.
datenreisender
force-pushed
the
split_docs
branch
from
d2c1df4 to
fd0add6
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Puts the “Get started” docs into a folder on its own. This will be used in the new unified docs.
But until the unified docs are put into production, I want to keep the original docs in a deployable state. So, this PR should not be merged until then.