Skip to content

Clarify validation scope, platform naming, and QNX licensing guidance in docs #73

Description

@nradakovic

Feature Request / Modification Description

Issue 2

Clarify validation scope, platform naming, and QNX licensing guidance in docs

Summary

Add follow-up clarifications to the documentation so users do not misinterpret the example workspace, platform support surface, or QNX licensing expectations.

Background

The expanded documentation still needs a few important clarifications:

  • the example workspace is a smoke-test surface, not a platform setup guide
  • supported platform families should use explicit and consistent naming
  • QNX licensing and integration expectations should be stated more clearly
  • repository layout documentation should avoid implying that examples are a full reference implementation

Scope

This issue covers:

  • clarifying that examples validate module extension changes and are not a platform development or setup reference
  • standardizing platform family naming with explicit architecture and OS identifiers
  • clarifying how QNX shared license paths are expected to be handled
  • clarifying that platform-specific setup details must be aligned with platform or module owners
  • tightening repository layout guidance so examples are not treated as the authoritative platform reference

Expected Deliverables

  • updated examples and validation documentation with explicit scope boundaries
  • updated overview documentation with clearer platform family naming
  • updated QNX integration guidance for licensing expectations
  • updated repository layout documentation with clearer usage guidance for examples

Acceptance Criteria

  • documentation clearly states what the example workspace proves and what it does not prove
  • platform support terminology is consistent and explicit
  • QNX licensing expectations are documented clearly enough to avoid setup ambiguity
  • repository layout documentation does not encourage misuse of examples as production platform guidance

Notes

This issue is about clarifying user expectations and reducing misuse of the documentation, especially for platform bring-up and QNX onboarding.

Expected Changes ot work products

  • Requirements
  • Architecture
  • Safety Analysis
  • Security Analysis
  • Detailed Design
  • Implementation and Testing
  • all

Impact analysis

None

Safety or Security relevance

  • none
  • Safety relevant
  • Security relevant

Expected required ASIL classification

QM

Expected Implementation Version (Release)

1.0

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation
No fields configured for Feature Request.

Projects

Status
Done
Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions