Skip to content

docs: root README β€” tagline + prose polish#146

Merged
mellonis merged 1 commit into
masterfrom
docs/readme-root
May 15, 2026
Merged

docs: root README β€” tagline + prose polish#146
mellonis merged 1 commit into
masterfrom
docs/readme-root

Conversation

@mellonis
Copy link
Copy Markdown
Owner

Summary

Five small fixes to the monorepo root README:

  • Tagline rewrite β€” `A convenient Turing machine` β†’ a feature-listing one-liner that mirrors the engine package's tagline.
  • Article fix β€” `This repository contains following packages` β†’ `contains the following packages`.
  • Prose β€” `The issue is to replace all `b` symbols by `` symbol.` β†’ `The task is to replace every `b` with ``.`
  • Dropped the `This example demonstrates an issue solving.` line β€” broken English; the `# An example` heading already says it.
  • Dropped leaked internal ref `(Pinning test in packages/machine/src/utilities/graph.spec.ts.)` from the `toMermaid` caption β€” doesn't help npm readers.

Test plan

Doc-only, single file. No code touched.

- Tagline rewrite: "A convenient Turing machine" β†’ feature-listing
  one-liner that mirrors the engine package's tagline.
- "contains following" β†’ "contains the following" (article fix).
- "The issue is to replace all `b` symbols by `*` symbol." β†’ "The
  task is to replace every `b` with `*`."
- Dropped the "This example demonstrates an issue solving." line β€”
  broken English; the heading "# An example" already conveys it.
- Dropped the leaked "(Pinning test in ...spec.ts)" reference from
  the toMermaid caption β€” internal-only, doesn't help npm readers.
@mellonis mellonis merged commit d19d743 into master May 15, 2026
5 checks passed
@mellonis mellonis deleted the docs/readme-root branch May 15, 2026 23:07
@github-project-automation github-project-automation Bot moved this from Todo to Done in @mellonis's machines May 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant