Skip to content

[FIX] Fix typos, grammar, and formatting across documentation#394

Open
dhanushpachabhatla wants to merge 3 commits intoneurobagel:mainfrom
dhanushpachabhatla:dhanush/docs-fix
Open

[FIX] Fix typos, grammar, and formatting across documentation#394
dhanushpachabhatla wants to merge 3 commits intoneurobagel:mainfrom
dhanushpachabhatla:dhanush/docs-fix

Conversation

@dhanushpachabhatla
Copy link
Copy Markdown

@dhanushpachabhatla dhanushpachabhatla commented Mar 6, 2026

Changes proposed in this pull request:

  • Fixed spelling mistakes in README.md ("side" to "site", "restaage" to "restage").
  • Corrected spelling of "Jean-Baptiste" in the team grid in docs/contributing/team.md.
  • Fixed the "particpant_id" typo to "participant_id" in docs/data_models/dictionaries.md.
  • Added a missing space after "e.g.," in docs/data_models/term_naming_standards.md.
  • Fixed subject-verb agreement in docs/user_guide/api.md ("sends" to "send").
  • Removed an accidental double space in docs/user_guide/data_prep.md.
  • Fixed subject-verb agreement in docs/user_guide/getting_started.md ("provide" to "provides").

Checklist

Please leave checkboxes empty for PR reviewers

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF]) see our Contributing Guidelines for more info)
  • PR links to GitHub issue with mention Closes #XXXX
  • Checks pass
  • If an existing page was renamed or deleted, redirects have been added to the mkdocs.yml config

@netlify
Copy link
Copy Markdown

netlify bot commented Mar 6, 2026

Deploy Preview for neurobagel-documentation ready!

Name Link
🔨 Latest commit a5f730e
🔍 Latest deploy log https://app.netlify.com/projects/neurobagel-documentation/deploys/69b3a3bb5c503200083ee603
😎 Deploy Preview https://deploy-preview-394--neurobagel-documentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions bot added the _community [BOT ONLY] PR label for community contributions. Used for tracking label Mar 6, 2026
@neurobagel-bot neurobagel-bot bot moved this to Community in Neurobagel Mar 7, 2026
@alyssadai alyssadai changed the title [DOC] Fix typos, grammar, and formatting across documentation [FIX] Fix typos, grammar, and formatting across documentation Mar 11, 2026
Copy link
Copy Markdown
Contributor

@alyssadai alyssadai left a comment

Choose a reason for hiding this comment

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

Thanks @dhanushpachabhatla for the PR! These fixes are much appreciated.

Did you use any specific tool to find these small errors? We may be interested in using it to check our other repos as well, since it seems our codespell config was not sufficient to catch these issues... 👀

@github-project-automation github-project-automation bot moved this from Community to Review - Active in Neurobagel Mar 12, 2026
@neurobagel-bot neurobagel-bot bot moved this from Review - Active to Community in Neurobagel Mar 12, 2026
@dhanushpachabhatla
Copy link
Copy Markdown
Author

Thanks @dhanushpachabhatla for the PR! These fixes are much appreciated.

Did you use any specific tool to find these small errors? We may be interested in using it to check our other repos as well, since it seems our codespell config was not sufficient to catch these issues... 👀

Thanks @alyssadai! I used Google Antigravity to help scan the Markdown files. It acts like an AI pair programmer and is really good at finding grammar and context-aware spelling issues.

P.S. I just pushed a quick fix for the markdownlint formatting error that was causing the pre-commit check to fail. Everything should be good to go now!

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

Labels

_community [BOT ONLY] PR label for community contributions. Used for tracking

Projects

Status: Community

Development

Successfully merging this pull request may close these issues.

2 participants