Skip to content

Documentation outdated: README.md Quick Start link points to non-existent docs/getting-started/quickstart page #920

@github-actions

Description

@github-actions

Problem

README.md line 5 contains this header link:

**[Quick Start]((rysweet.github.io/redacted)

The local repository has no docs/getting-started/ directory and no quickstart.md file. The MkDocs site at `(rysweet.github.io/redacted) likely 404s or redirects.

The closest local resources are:

  • docs/tutorials/quick-start-restore.md (session restore specific)
  • docs/tutorials/platform-setup-restore.md
  • README.md itself (has a "Quick Start" section at line 54)

Impact

Users clicking the header "Quick Start" link from GitHub or the published docs site hit a missing page.

Suggested Fix

Either:

  1. Create docs/getting-started/quickstart.md pointing to the quick-start content already in README.md, and add it to mkdocs.yml.
  2. Or update the link to point to an existing page (e.g., docs/tutorials/quick-start-restore.md or the README's own Quick Start section).

File

README.md — line 5 (header link bar)

Generated by Documentation Freshness Checker

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions