Skip to content

Documentation Request: Improve coverage of new features and API methods #50

@ghost

Description

First, thank you for the great work on scribe.js-ocr! The library is powerful, but I'm having difficulty using it to its full potential because the documentation seems to be lagging behind the development of new features. Or am I wrong?

As a new user, I found it challenging to discover what the package is truly capable of. I suspect there are features and API methods that exist in the codebase but are not documented, or are only mentioned briefly without practical examples.

I would kindly request a comprehensive review and update of the documentation. Specifically, it would be incredibly helpful if the docs included:

  1. API reference: description of what is expected to happen if we define one value or another for a given option; more info on how to define the options from Tesseract.js; a full list of exported methods, and their options/parameters.

  2. Examples: handling different languages or character sets and languages combined (to define in scribe.js-ocr or in tesseract options?); suggestions for adjusting accuracy/confidence thresholds according to known most-used scenarios; suggestions regarding how to properly export results to different formats (e.g., structured text, txt).

All the best!!!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions