Skip to content

docs: update PRD with 2026 merged PR changes#659

Draft
aitestino wants to merge 1 commit intomainfrom
docs/prd-update-from-2026-prs
Draft

docs: update PRD with 2026 merged PR changes#659
aitestino wants to merge 1 commit intomainfrom
docs/prd-update-from-2026-prs

Conversation

@aitestino
Copy link
Collaborator

Summary

Comprehensive update to PRD_AND_ARCHITECTURE.md reflecting all features and architectural changes from 2026 merged pull requests through v2.0.0a1.

Changes

New Deep-Dive Sections:

  • Pre-Flight Validation: fail-fast authentication architecture with AuthCheckResult, AuthOutcome, two-tier error classification
  • Diagnostic Collection: nac-test-diagnostic.sh invocation, architecture, credential masking
  • Platform Safety Gates: macOS Python version checks, PyATS git_info disable, SSL/fork safety
  • GitHub Templates: PR and issue template documentation for contributor experience

Enhanced Existing Sections:

  • D2D hostname flow: DeviceExecutor → SubprocessRunner → base_test → HTML reporting
  • Skipped device reporting: resolver → DeviceInventoryDiscovery → CLI warning pipeline
  • Test discovery: content-based detection with regex patterns (removed strict path requirements)
  • Environment variables: NAC_TEST_ and NAC_TEST_PYATS_ prefix standardization
  • Parallel execution: combined dashboard, xunit merger, worker memory tuning (2.0→0.35 GB)
  • Robot Framework exit codes: 0=pass, 1-250=failures, 252=no tests, 253=interrupted, 255=error
  • Dry-run support: --dry-run flag for test validation

Document Maintenance:

  • Updated version to 2.0 / 2026-03 / nac-test 2.0.0a1
  • Fixed ToC anchors and cross-references
  • Standardized terminology consistency
  • Removed obsolete REPORTING_PLAN_OPTION_D.md

Stats: 1,257 insertions, 2,089 deletions across 2 files

Related Issues

Closes #596


Review Focus:

  • Technical accuracy of new sections against source code
  • Consistency with existing documentation style and mermaid diagram patterns
  • Completeness of 2026 PR coverage

Ready for: Technical review and merge to main

Comprehensive update to PRD_AND_ARCHITECTURE.md reflecting all features
and changes from 2026 merged pull requests.

New sections added:
- Pre-Flight Validation: fail-fast authentication architecture with
  AuthCheckResult, AuthOutcome enum, two-tier error classification
- Diagnostic Collection: nac-test-diagnostic.sh invocation and architecture
- Platform Safety Gates: macOS Python version checks, PyATS git_info
  disable, SSL/fork safety measures
- GitHub Templates: PR and issue template documentation

Enhanced existing sections:
- D2D hostname flow through DeviceExecutor to HTML reporting
- Skipped device reporting pipeline with _last_resolver pattern
- Test discovery relaxation with content-based detection
- Environment variable naming conventions (NAC_TEST_ prefix)
- Combined dashboard and xunit merger documentation
- Worker memory tuning (MEMORY_PER_WORKER_GB)
- Robot Framework exit codes
- Dry-run support

Maintenance:
- Updated document version to 2.0 / 2026-03 / nac-test 2.0.0a1
- Fixed ToC anchors and cross-references
- Standardized terminology (pre-flight hyphenation)
- Removed obsolete REPORTING_PLAN_OPTION_D.md

Co-Authored-By: Daniel Schmidt <noreply@example.com>
@aitestino aitestino added the documentation Improvements or additions to documentation label Mar 18, 2026
@aitestino aitestino self-assigned this Mar 18, 2026
@aitestino aitestino added the documentation Improvements or additions to documentation label Mar 18, 2026
@aitestino aitestino changed the base branch from main to release/pyats-integration-v1.1-beta March 18, 2026 23:42
@oboehmer oboehmer mentioned this pull request Mar 22, 2026
@oboehmer oboehmer changed the base branch from release/pyats-integration-v1.1-beta to main March 22, 2026 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: update PRD_AND_ARCHITECTURE.md to reflect current implementation

1 participant