Final Closure Checklist

[melanielaporte]

MoonRat Project: Final Closure Checklist

Target Date: September 1st

This issue tracks the final closure tasks to transition the project from active development to a stable, public-facing open-source resource. All tasks must be completed before this issue and the linked milestone can be closed.

---

Phase 1: Repository & Code Cleanup (The "Final Sweep")

• Review and Tidy File Structure: Ensure logical organization (e.g., docs/, hardware/, firmware/, software/, images/).
• Remove Redundant Files: Delete all obsolete design files, duplicates, broken links, and temporary/personal files.
• Standardize Naming Conventions: Ensure all files and folders use clear, consistent names.
• Final Code Linting/Formatting: Run code through formatters for consistent style and readability.
• Comment Critical Sections: Ensure complex code has clear explanations.

Phase 2: Documentation & Onboarding (The "User Manual")

• Overhaul the README.md:
  • Add a project logo/banner.
  • Write a compelling project description.
  • Create a detailed Table of Contents.
  • Add clear "Getting Started" instructions.
• Finalize the Bill of Materials (BOM): Create a precise, linked BOM with supplier part numbers.
• Create/Verify Assembly Instructions: Include a step-by-step guide with high-resolution photos or diagrams.
• Add a Citation File (CITATION.cff): Make it easy for researchers to cite the project and the HardwareX paper.
• Ensure License Clarity: Confirm the LICENSE file is present and correct; add license headers to key source files.

Phase 3: Tying to the Scientific Publication (The "Credibility Link")

• Create a paper/ folder for publication-related assets.
• Add the HardwareX Paper Draft: Upload the submitted manuscript PDF.
• Link Code/Design to Paper: In the README, state: "Details in a forthcoming paper submitted to HardwareX (DOI/Link to be added)."
• Prepare for Revisions: Ensure the repo is in a state where reviewers can easily build the project to verify results.

Phase 4: Prototype Verification & Asset Creation (The "Proof")

• Gather Proof of Builds: Document the three built prototypes in 3 cities.
• Create a gallery/ folder: Add high-quality photos and short videos of each working prototype.
• Add a "Built by Others" Section: In the README, encourage users to submit pictures of their builds.

Phase 5: Final Repository Settings & Public Launch (The "Release")

• Create a Release Version: Package the final state as "v1.0.0" on GitHub.
• Add Keywords/Topics: Update repository topics for discoverability (e.g., neuroscience, open-hardware, arduino).
• Check Issue Templates: Set up basic GitHub Issue templates for bug reports and feature requests.
• Plan Public Announcement: Draft posts for relevant platforms (e.g., Twitter, LinkedIn, Hackaday) to go live on Sep 1st.

---

Completion Criteria: This issue will be closed when all checklist items are complete and the "Project Closure" milestone is achieved.