Skip to content

docs: Update README and contributors guide#53

Merged
rclune merged 6 commits into
stagingfrom
docs
Oct 13, 2025
Merged

docs: Update README and contributors guide#53
rclune merged 6 commits into
stagingfrom
docs

Conversation

@rclune

@rclune rclune commented Oct 9, 2025

Copy link
Copy Markdown
Member

Added notes about required file downloads and clarified example usage for parsing PDB files. Updated import statements and corrected file paths in documentation to improve clarity and accuracy for users.

📋 PR Checklist

  • This PR is tagged as a draft if it is still under development and not ready for review.

    This avoids auto-triggering the slower tests in the CI and needlessly wasting resources.

  • [ x] I have ensured that all my commits follow angular commit message conventions.

    Format: <type>[optional scope]: <subject>
    Example: fix(af3): add missing crop transform to the af3 pipeline

    This affects semantic versioning as follows:

    • fix: patch version increment (0.0.1 → 0.0.2)
    • feat: minor version increment (0.0.1 → 0.1.0)
    • BREAKING CHANGE: major version increment (0.0.1 → 1.0.0)
    • All other types do not affect versioning

    The format ensures readable changelogs through auto-generation from commit messages.

  • [x ] I have run make format on the codebase before submitting the PR (this autoformats the code and lints it).

  • [ x] I have named the PR in angular PR message format as well (c.f. above), with a sensible tag line that summarizes all the changes in the PR.

    This is useful as the name of the PR is the default name of the commit that will be used if you merge with a squash & merge.
    Format: <type>[optional scope]: <subject>
    Example: fix(af3): add missing crop transform to the af3 pipeline


ℹ️ PR Description

What changes were made and why?

How were the changes tested?

Additional Notes

Added notes about required file downloads and clarified example usage for parsing PDB files. Updated import statements and corrected file paths in documentation to improve clarity and accuracy for users.
rclune added 4 commits October 9, 2025 11:39
Added a new section clarifying when to use atomworks.io vs atomworks.ml. Improved installation instructions and clarified that multiple installs only add dependencies. Updated the getting started section to reference external documentation and reorganized quick start instructions. Updated contribution link to point to the new contributor guide.
Updated installation instructions to include dotenv dependency.
Expanded the contributor guide with clearer commit and PR instructions, added documentation on building docs with Sphinx, and improved branch naming and workflow details. Added a reference label for the local Conda environment in the installation guide for easier cross-referencing.
@rclune rclune changed the title Update README with usage notes and path corrections docs: Update README and contributors guide Oct 10, 2025

@nscorley nscorley left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much for this PR! A couple minor nits then ready to merge

Comment thread docs/contributor_guide.rst Outdated
Comment thread docs/installation.rst Outdated
Comment thread README.md Outdated
Updated documentation URLs to point to rosettacommons.github.io instead of baker-laboratory.github.io. Clarified installation instructions for Open Babel and updated contributor guide to use a requirements file for documentation dependencies. Removed outdated Apptainer instructions and improved clarity in installation steps.
@rclune rclune merged commit ec0942f into staging Oct 13, 2025
@rclune rclune deleted the docs branch October 13, 2025 23:32
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 1.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants