Skip to content

[Doc Review] Broken/incorrect internal links in API docs #55

@Tom-Dynamsoft

Description

@Tom-Dynamsoft

Documentation Issue: Broken/incorrect internal links

Category: Freshness & Consistency
Severity: Warning
Found by: docs-updater review mode (2026-02-25)
SDK: MRZ Scanner JavaScript Edition
Finding IDs: F6, F7

Problem

Two internal link issues found:

  1. api/mrz-scanner.md (line ~521): The ResultStatus section links to {{ site.api }}enums-mrz-scanner.md#enumresultstatus using .md extension. Should be .html for the generated site.

  2. api/index.md (line 49): The EnumMRZData link [EnumMRZData](enums-mrz-scanner.md) is missing the #enummrzdata anchor.

Recommended Fix

  1. Change .md to .html: {{ site.api }}enums-mrz-scanner.html#enumresultstatus
  2. Add the anchor: [EnumMRZData](enums-mrz-scanner.md#enummrzdata)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationreview-findingFinding from automated documentation review

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions