Skip to content

Docs: add a Troubleshooting / FAQ section to the README #1

Description

@ibrahimqureshae

Newcomers hit the same few questions (SmartScreen warning, WebView2, first-run download, where output .md files land). Let's collect them in one place.

Task: add a ## Troubleshooting (or FAQ) section near the bottom of README.md, or a docs/FAQ.md linked from the README.

Suggested entries:

  • "Windows protected your PC" SmartScreen → More info → Run anyway (build is unsigned/open-source).
  • First launch is downloading for a while → it's provisioning the local Python env (one-time).
  • A conversion returned a warning/empty result → what the diagnostics panel shows and how to read it.
  • Where converted files are saved.

Good first issue because: docs-only, no build required. Read the existing README for tone.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions