Skip to content

Review fixes - #11

Merged
iraiosub merged 17 commits into
mainfrom
review-fixes
Jul 28, 2026
Merged

Review fixes#11
iraiosub merged 17 commits into
mainfrom
review-fixes

Conversation

@iraiosub

Copy link
Copy Markdown
Contributor

Summary

  • Improved protocol style validation and fixing for edge cases:

    • avoids false positives for labels such as 25S rRNA, 3S RNA, Figure 2H, CHIP3, FISH3, and NGS2
    • normalizes ddH2O to ddH<sub>2</sub>O
    • clarifies Greek mu μ versus micro sign µ diagnostics for copy/pasteable fixes
  • Improved generated PDFs:

    • renders HTML subscripts as proper PDF subscripts
    • improves PDF header layout for repository URL, commit hash, and actor metadata
  • Improved README validation workflow:

    • content validation and style/unit validation now both run after validator tests pass
    • users can see structural and unit/style issues in the same CI run
  • Improved legacy migration guidance:

    • harmonized docs/PROMPT.md, Copilot instructions, and protocol-migration skills
    • clarified allowed formatting normalization, migration notes, image/table handling, and output requirements
    • keeps the template attribution badge while avoiding template release-version badges in migrated protocol README files
  • Improved user documentation:

    • expanded release guidance
    • added tips for issues, projects, pull requests, and Slack notifications
    • added maintainer/contributor notes for template maintainers
    • clarified that the required Materials section must be top-level and may be numbered, for example # Materials or # 7. Materials

@iraiosub iraiosub self-assigned this Jul 28, 2026
@iraiosub iraiosub added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 28, 2026
@iraiosub
iraiosub merged commit aebad07 into main Jul 28, 2026
1 check failed
@iraiosub
iraiosub deleted the review-fixes branch July 28, 2026 15:55
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 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant