Skip to content

Fix spelling, grammar, and content errors across docs/#4022

Open
Copilot wants to merge 3 commits intomainfrom
copilot/analyze-docs-catalog
Open

Fix spelling, grammar, and content errors across docs/#4022
Copilot wants to merge 3 commits intomainfrom
copilot/analyze-docs-catalog

Conversation

Copy link

Copilot AI commented Feb 27, 2026

🛠 Summary

Audit of all 73 markdown files in docs/ and subdirectories. Fixed spelling, grammar, and factual heading errors found across 11 files.

Fixes applied:

  • docs/llm/reference.mdit'sits; Seconds partSecond part; there is not needthere is no need
  • docs/security_considerations.mdbe defaultby default
  • docs/starting_server.mdtwo method fortwo methods for
  • docs/speech_recognition/reference.md — Section heading Text to speech calculator limitationsSpeech to text calculator limitations (wrong domain)
  • docs/models_repository_graph.mdof behavesit behaves; also requirealso requires; In can the graphIn case the graph
  • docs/legacy.md[Learn model][Learn more]; not supportnot supported
  • docs/advanced_topics.mdnot supportnot supported
  • docs/deploying_server_kubernetes.md — Fixed double-parentheses ((https://...)) in markdown link (renders broken)
  • docs/mediapipe.md — Swapped input/output values in table; mismatched backtick/single-quote; BesideBesides
  • docs/performance_tuning.mdeffectively results with extra 1-2s latencyeffectively result in extra 1-2s latency
  • docs/clients_genai.mdBeside Tensorflow Serving APIBesides Tensorflow Serving API

🧪 Checklist

  • Unit tests added.
  • The documentation updated.
  • Change follows security best practices.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

- docs/llm/reference.md: it's -> its (possessive), 'Seconds part' -> 'Second part', 'there is not need' -> 'there is no need'
- docs/security_considerations.md: 'be default' -> 'by default'
- docs/starting_server.md: 'two method for' -> 'two methods for'
- docs/speech_recognition/reference.md: wrong section heading 'Text to speech calculator limitations' -> 'Speech to text calculator limitations'
- docs/models_repository_graph.md: 'of behaves' -> 'it behaves', 'also require' -> 'also requires', 'In can the graph' -> 'In case the graph'
- docs/legacy.md: '[Learn model]' -> '[Learn more]', 'not support' -> 'not supported'
- docs/advanced_topics.md: 'not support' -> 'not supported'
- docs/deploying_server_kubernetes.md: fix double-parentheses in markdown link
- docs/mediapipe.md: fix table wrong input/output column values, fix mismatched backtick quote, 'Beside' -> 'Besides'
- docs/performance_tuning.md: 'effectively results with' -> 'effectively result in'
- docs/clients_genai.md: 'Beside' -> 'Besides'

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI changed the title [WIP] Analyze documents in catalog for coherence and errors Fix spelling, grammar, and content errors across docs/ Feb 27, 2026
@mzegla mzegla marked this pull request as ready for review February 27, 2026 14:05
Copilot AI review requested due to automatic review settings February 27, 2026 14:05
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Documentation-only PR that audits and corrects typos/grammar and a few content/heading issues across docs/, improving clarity and rendering for OVMS user-facing documentation.

Changes:

  • Fixes multiple typos/grammar issues across several markdown docs.
  • Corrects a domain-mismatched section heading in the speech recognition docs.
  • Repairs broken markdown link formatting and adjusts a MediaPipe table for correctness.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
docs/starting_server.md Fixes a grammatical error (“two methods”).
docs/speech_recognition/reference.md Corrects a section heading to match speech-to-text domain.
docs/security_considerations.md Fixes a typo (“by default”).
docs/performance_tuning.md Adjusts wording in network performance note (still has minor issues to address).
docs/models_repository_graph.md Fixes several phrasing issues (still contains a remaining grammar issue).
docs/mediapipe.md Corrects table input/output entries and minor markdown punctuation (one minor wording improvement suggested).
docs/llm/reference.md Fixes multiple grammar issues (one sentence still needs a small grammar tweak).
docs/legacy.md Fixes “not supported” wording and link text.
docs/deploying_server_kubernetes.md Fixes broken markdown link rendering.
docs/clients_genai.md Fixes “Beside” → “Besides” (still needs TensorFlow capitalization).
docs/advanced_topics.md Fixes “not supported” wording.

```

In can the graph includes python nodes, there should be included also a python file with the node implementation.
In case the graph includes python nodes, there should be included also a python file with the node implementation.
Copy link

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

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

This line uses inconsistent capitalization and awkward phrasing (“python nodes”, “included also a python file”). Consider using “Python nodes” / “Python file” and rephrasing to a more direct construction (e.g., “the repository should also include a Python file implementing the node”).

Copilot uses AI. Check for mistakes.
## Network Configuration for Optimal Performance

By default, OVMS endpoints are bound to all ipv4 addresses. On same systems, which route localhost name to ipv6 address, it might cause extra time on the client side to switch to ipv4. It can effectively results with extra 1-2s latency.
By default, OVMS endpoints are bound to all ipv4 addresses. On same systems, which route localhost name to ipv6 address, it might cause extra time on the client side to switch to ipv4. It can effectively result in extra 1-2s latency.
Copy link

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

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

This sentence has a couple of remaining issues: “ipv4/ipv6” should be capitalized as “IPv4/IPv6”, and “On same systems” should likely be “On some systems” (current wording reads incorrect).

Copilot uses AI. Check for mistakes.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Check [supported models](https://openvinotoolkit.github.io/openvino.genai/docs/supported-models/#speech-recognition-models).

### Text to speech calculator limitations
### Speech to text calculator limitations
Copy link
Collaborator

Choose a reason for hiding this comment

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

@michalkulakowski is it correct?

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.

6 participants