Skip to content

Fix and organize README documentation#3

Open
phonchi wants to merge 1 commit into
mainfrom
claude/fix-readme-organization-01YUvfLAEsGvZYEeaCPfGgyU
Open

Fix and organize README documentation#3
phonchi wants to merge 1 commit into
mainfrom
claude/fix-readme-organization-01YUvfLAEsGvZYEeaCPfGgyU

Conversation

@phonchi

@phonchi phonchi commented Nov 23, 2025

Copy link
Copy Markdown
Owner
  • 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
@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello @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

  • Documentation Organization: The README's table of contents has been comprehensively updated and expanded to include all sections and subsections with a proper hierarchical structure, improving navigation and clarity.
  • Grammar and Spelling Corrections: Numerous grammar and spelling errors, such as 'Deomnstrate' to 'Demonstrates' and 'focus on' to 'focused on', have been fixed to enhance readability and professionalism.
  • Content Refinement: Duplicate entries for tools like TomoTwin and Ctfplotter have been removed, and the 'Resources' subsection was renamed to 'Learning Resources' to avoid confusion. A PolNet paper link was also corrected to point to the actual publication.
  • Formatting Standardization: Consistent formatting has been applied throughout the document, including the standardized use of backticks for software names, uniform list numbering, consistent hyphenation (e.g., 'Fiducial-based'), and corrected spacing around dashes and parentheses.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

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 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.

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.

2 participants