Skip to content

docs: prepare v0.2.4 for pyOpenSci readiness#9

Merged
NanoBiostructuresRG merged 9 commits into
mainfrom
dev/v0.2.4
Jun 6, 2026
Merged

docs: prepare v0.2.4 for pyOpenSci readiness#9
NanoBiostructuresRG merged 9 commits into
mainfrom
dev/v0.2.4

Conversation

@NanoBiostructuresRG

Copy link
Copy Markdown
Owner

Summary

This PR prepares HARMONSMILE dev/v0.2.4 for pyOpenSci-oriented review readiness.

Main changes:

  • Strengthens project documentation for external scientific users.
  • Adds and refines contribution and code-of-conduct guidance.
  • Aligns citation metadata and DOI references for v0.2.4.
  • Improves MkDocs layout responsiveness and prevents table overflow.
  • Adds a dedicated Usage page and keeps the Home page focused on scientific motivation, workflow overview, and navigation.
  • Ensures MkDocs build output is ignored via .gitignore.

Validation

  • git diff --check
  • python -m mkdocs build --strict
  • Local visual inspection of:
    • /harmonsmile/
    • /harmonsmile/usage/
    • /harmonsmile/api/
    • /harmonsmile/changelog/

No package source code, API behavior, CLI behavior, chemistry behavior, or workflow behavior was changed.

@NanoBiostructuresRG NanoBiostructuresRG merged commit 4e61bd3 into main Jun 6, 2026
4 checks passed
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.

1 participant