Skip to content

[Docs]: Editorial pass — consistency, install path, and dead ends #14

Description

@rosspeili

Doc location

Repo-wide: README.md, docs/**, docs/releases/**, CONTRIBUTING cross-links

What kind of change?

Outdated or wrong information

What’s wrong or missing?

Post-v0.2.0 shipping left some drift risk: install order is correct in README, but deep pages may still under-emphasize the .exe, over-emphasize dev:desktop, or lack links to releases index. Screenshots are PNG-heavy (see GIF issue). Architecture Mermaid was fixed; other pages need a single editorial pass for tone (visitor-facing, no maintainer ops language).

Suggested fix (optional)

  1. Every “how do I run this?” path matches: exe → npm run desktopnpm run dev.
  2. Grep for: planned, draft, desktop-setup, upload, gitignored, internal ops wording — remove or rephrase.
  3. Ensure Voice/Electron-only warnings are consistent.
  4. Link docs/releases/README.md from docs index (already partly done).
  5. Cross-link CONTRIBUTING ripple table where useful.
  6. Coordinate with motion GIF issue for embeds; do not block this pass on GIFs.

Checklist

  • I searched existing issues for a duplicate

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationDocumentation, README, screenshots, or guidesgood first issueGood for newcomers — scoped and approachable

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions