-
Notifications
You must be signed in to change notification settings - Fork 14
Fix and organize README documentation #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Fix and organize README documentation #2
Conversation
phonchi
commented
Nov 23, 2025
- Fix title casing: "CryoEM" → "Cryo-EM" for consistency
- Fix grammar typo: "Deomnstrate" → "Demonstrate"
- Fix scientific term: "Ab-initial" → "Ab-initio"
- Fix incomplete sentence in damage compensation section
- Fix typo: "Multirefence" → "Multireference"
- Rename duplicate "Resources" subsection to "Additional Resources"
- Standardize TOC anchor links to lowercase for consistency
- Fix grammar: "dark/gain corrected" → "dark/gain correction"
- Improve overall document organization and readability
- Fix title casing: "CryoEM" → "Cryo-EM" for consistency - Fix grammar typo: "Deomnstrate" → "Demonstrate" - Fix scientific term: "Ab-initial" → "Ab-initio" - Fix incomplete sentence in damage compensation section - Fix typo: "Multirefence" → "Multireference" - Rename duplicate "Resources" subsection to "Additional Resources" - Standardize TOC anchor links to lowercase for consistency - Fix grammar: "dark/gain corrected" → "dark/gain correction" - Improve overall document organization and readability
Summary of ChangesHello @phonchi, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the quality and readability of the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces several valuable fixes to the README file, including correcting typos, improving grammar, and enhancing consistency in terminology and formatting. These changes significantly improve the quality and readability of the documentation. I've identified one issue where a change to an anchor link in the table of contents will cause it to break, and I have provided a specific comment with a suggestion to resolve it. Overall, this is a great contribution to the project's documentation.
|
|
||
|
|
||
| - [**Computational CryoEM Methods**](#computational-cryoEM-methods) | ||
| - [**Computational Cryo-EM Methods**](#computational-cryo-em-methods) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change updates the link text to Cryo-EM for consistency, which is great. However, the anchor link was also changed to #computational-cryo-em-methods, which will now be a broken link. The corresponding document title on line 1 is still # Computational CryoEM Methods, which generates the anchor #computational-cryoem-methods.
To fix this properly, the title on line 1 should also be updated to # Computational Cryo-EM Methods. Since that line is not part of this diff, I'm suggesting a fix that keeps your text change but reverts the anchor change to prevent the broken link.
| - [**Computational Cryo-EM Methods**](#computational-cryo-em-methods) | |
| - [**Computational Cryo-EM Methods**](#computational-cryoem-methods) |