Skip to content

Add SQA-oriented operations and troubleshooting guidance to README#296

Open
Copilot wants to merge 4 commits into
developfrom
copilot/add-sqa-documentation
Open

Add SQA-oriented operations and troubleshooting guidance to README#296
Copilot wants to merge 4 commits into
developfrom
copilot/add-sqa-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 7, 2026

artdaq’s Moderate SQA classification requires user-facing documentation for basic operation and common failure modes. This PR adds concise operational guidance and a troubleshooting section in the main README, aligned with existing artdaq-demo onboarding.

  • What was added

    • New “Basic operation (SQA)” section in README.md:
      • points users to artdaq-demo as the primary getting-started path
      • documents the standard run lifecycle (environment setup → process start with FHiCL → run-control transitions → log review)
    • New “Common errors and troubleshooting (SQA)” section:
      • missing environment/library setup
      • invalid FHiCL configuration
      • transfer/network connectivity issues
      • stale shared-memory resources after abnormal termination
      • art process startup/runtime failures with PMT/MessageFacility log triage guidance
  • Documentation shape

    • Keeps guidance at operator level (symptoms + actions), without introducing implementation-specific internals.
    • Extends existing README structure rather than adding new docs files.
## Common errors and troubleshooting (SQA)

* **Invalid FHiCL configuration**  
  Symptoms include configuration parsing exceptions or process failure during initialization.  
  Action: validate FHiCL syntax/parameter names and retry with corrected configuration.

Copilot AI and others added 2 commits May 7, 2026 13:58
Copilot AI changed the title [WIP] Add documentation for basic operations and common errors for SQA Add SQA-oriented operations and troubleshooting guidance to README May 7, 2026
Copilot AI requested a review from eflumerf May 7, 2026 14:02
@eflumerf eflumerf marked this pull request as ready for review May 7, 2026 18:49
@eflumerf eflumerf requested a review from ron003 May 7, 2026 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 📋 Triage

Development

Successfully merging this pull request may close these issues.

Add documentation for basic operation and common errors for SQA

3 participants