docs: Provide additional information in docs#65
Merged
Conversation
Update examples_and_validation.md to state examples only validate module extension changes and are not a platform setup reference. Standardize supported platform family entries in overview.md with explicit AMD64/ARM64 names and Bazel identifiers. Clarify QNX shared license path and agreement with platform/module owners in qnx_integration.md. Add a note in repository_layout.md that examples should not be used as a platform development reference.
nradakovic
requested review from
AlexanderLanin,
antonkri and
dcalavrezo-qorix
as code owners
There was a problem hiding this comment.
Pull request overview
This PR updates documentation to clarify the purpose/limits of the example workspace, standardize platform family naming, and refine QNX licensing guidance.
Changes:
- Clarifies that
examples/is a sanity-check surface and not a full platform setup reference. - Standardizes platform family naming in
overview.mdwith explicit AMD64/ARM64 labels and Bazel identifiers. - Updates QNX integration documentation around shared license path and credential helper usage.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/repository_layout.md | Adds notes about templates consolidation plans and clarifies examples/ are not a platform development reference. |
| docs/qnx_integration.md | Clarifies default shared license path and adjusts credential helper description. |
| docs/overview.md | Standardizes supported platform family entries (AMD64/ARM64 + identifiers). |
| docs/examples_and_validation.md | Adds explicit disclaimer about the examples’ scope and validation intent. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
AlexanderLanin
approved these changes
Jun 22, 2026
This was
linked to
issues
Jun 30, 2026
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
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.
Update examples_and_validation.md to state examples only validate module extension changes and are not a platform setup reference. Standardize supported platform family entries in overview.md with explicit AMD64/ARM64 names and Bazel identifiers.
Clarify QNX shared license path and agreement with platform/module owners in qnx_integration.md.
Add a note in repository_layout.md that examples should not be used as a platform development reference.