Skip to content

feat!: modernize the X-Sub research archive#3

Merged
ddtdanilo merged 1 commit into
masterfrom
agent/archive-modernization
Jul 25, 2026
Merged

feat!: modernize the X-Sub research archive#3
ddtdanilo merged 1 commit into
masterfrom
agent/archive-modernization

Conversation

@ddtdanilo

Copy link
Copy Markdown
Collaborator

Summary

  • rebuild the repository documentation in English from the archived firmware and 2016 thesis
  • add architecture, hardware, protocol, safety, archival-status, contribution, support, citation, agent, and third-party guidance
  • add a maintained dependency-free Python 3.11+ decoder/encoder for the documented 27-byte telemetry and 10-byte command formats
  • add 15 protocol tests, repository-integrity checks, artifact hashes, Ruff, CI, CodeQL, Dependabot, ownership, and issue/PR templates
  • remove 3,179 generated or transient files (IDE workspace state, Altium edit histories/previews/logs, runtime logs, bytecode, and autosaves), all still recoverable from Git history

Validation

  • 15 unit tests pass
  • Ruff lint and format checks pass
  • repository integrity and immutable action-pin checks pass
  • primary artifact SHA-256 hashes pass
  • Python sdist and wheel build successfully
  • workflow, issue-form, Dependabot, and citation YAML parse successfully
  • deletion audit: 3,179 expected generated files; 0 unexpected source files
  • git diff --check passes

Safety and compatibility

  • original firmware, PCB sources, fabrication outputs, LabVIEW, Simulink, and the complete thesis are preserved
  • proprietary legacy projects were not rewritten or claimed compatible with current tools
  • hardware and serial-protocol limitations are documented explicitly

This PR establishes v1.0.0 of the curated historical archive.

Document the historical system, add maintained protocol tools and tests, establish repository governance and CI, and remove generated workspace artifacts from the current branch.
@ddtdanilo
ddtdanilo marked this pull request as ready for review July 25, 2026 06:15
@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@ddtdanilo
ddtdanilo merged commit 22aa305 into master Jul 25, 2026
6 checks passed
@ddtdanilo
ddtdanilo deleted the agent/archive-modernization branch July 25, 2026 06:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants