Skip to content

docs: fix broken localhost URL in modular LLM stack example and spelling errors - #1706

Open
toyeshhm wants to merge 1 commit into
apache:mainfrom
toyeshhm:fix-doc-typos
Open

docs: fix broken localhost URL in modular LLM stack example and spelling errors#1706
toyeshhm wants to merge 1 commit into
apache:mainfrom
toyeshhm:fix-doc-typos

Conversation

@toyeshhm

@toyeshhm toyeshhm commented Sep 9, 2026

Copy link
Copy Markdown

Documentation-only corrections; no code or behavioral change.

Changes

Two of these affect copy-pasteable instructions:

  • examples/LLM_Workflows/modular_llm_stack/README.md: the Weaviate invocation reads --vector_db_config='{"url": "http://locahost:8080/"}'. The Marqo and Qdrant lines beside it use localhost, so anyone copying the Weaviate line gets a resolution failure. Fixed to localhost.
  • examples/kedro/hamilton-code/README.md: refers to noteboks/interactive.ipynb, but the directory is notebooks/. Also interactilyinteractively on the same line.

The rest are plain spelling fixes across READMEs, docs/, and writeups/, e.g. respository, initilization, quries, overriden, modeul, Additionnally, customizeable, inteface, commited, ressource, allways, eaisly, Excute, paralellism, parametter, depdendencies, pacakge, repetetive; informationsinformation; everytimeevery time; wontwon't; doesn't makse sensedoesn't make sense; and two doubled words (go the thego to the, including in the PR template).

Left alone on purpose: rouge (the ROUGE metric), re-use/referencable (style, not errors).

How I tested this

Re-read each changed line in context. git diff --check is clean. Only .md files are touched; 28 files, 34 lines.

Notes

git diff --word-diff shows the changes compactly.

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested (N/A, docs only)
  • New functions are documented (with a description, list of inputs, and expected output) (N/A)
  • Placeholder code is flagged / future TODOs are captured in comments (N/A)
  • Project documentation has been updated if adding/changing functionality. (N/A)

The Weaviate invocation in examples/LLM_Workflows/modular_llm_stack/README.md
pointed at http://locahost:8080/, which fails to resolve when copied. The
kedro example README referenced a noteboks/ directory that does not exist
(the directory is notebooks/).

Also corrects spelling across READMEs, docs, and writeups (repository,
initialization, queries, overridden, module, pipeline, localhost, parallelism,
dependencies, package, etc.), two doubled words, and won't/every time.
Copilot AI lite review requested due to automatic review settings September 9, 2026 17:27

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Copilot stopped reviewing on behalf of toyeshhm due to an error September 9, 2026 20:44
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