Fix and organize README documentation#3
Conversation
phonchi
commented
Nov 23, 2025
- Fixed grammar and spelling errors (Deomnstrate → Demonstrates, "focus on" → "focused on")
- Updated table of contents to include all sections and subsections with proper hierarchy
- Renamed "Resources" subsection to "Learning Resources" to avoid naming confusion
- Removed duplicate entries (TomoTwin in Particle picking, Ctfplotter in CTF estimation)
- Standardized formatting throughout:
- Consistent use of backticks for software names
- Standardized list numbering format
- Fixed spacing issues around dashes and parentheses
- Consistent hyphenation (Fiducial-based, Fiducial-less)
- Fixed PolNet paper link to point to actual publication instead of GitHub repo
- Removed trailing whitespace from entries
- Fixed grammar and spelling errors (Deomnstrate → Demonstrates, "focus on" → "focused on") - Updated table of contents to include all sections and subsections with proper hierarchy - Renamed "Resources" subsection to "Learning Resources" to avoid naming confusion - Removed duplicate entries (TomoTwin in Particle picking, Ctfplotter in CTF estimation) - Standardized formatting throughout: - Consistent use of backticks for software names - Standardized list numbering format - Fixed spacing issues around dashes and parentheses - Consistent hyphenation (Fiducial-based, Fiducial-less) - Fixed PolNet paper link to point to actual publication instead of GitHub repo - Removed trailing whitespace from entries
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 significantly improves the quality and organization of the project's README documentation. The changes aim to make the information more accessible, accurate, and consistent for anyone consulting the guide. By refining the structure, correcting textual errors, and standardizing presentation, the README now serves as a more reliable and user-friendly resource. 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.
Code Review
This pull request significantly improves the README file by fixing grammatical errors, updating the table of contents, standardizing formatting, and removing duplicate entries. The changes enhance readability and organization. I have one minor suggestion to ensure consistency in formatting.