Skip to content

README demo link for the table of contents opens an empty view #809

Open

Description

@HMarzban

What is wrong

README.md:51 links https://docs.plus/demo/invisible as "Try it in the demo", in the paragraph "Find the busy sections".

A demo link is a filter, not an anchor. The word in the link must appear in a section of the demo. The word "invisible" no longer appears in the demo text, so the filter matches no section. A reader who clicks the link sees only the demo's short intro.

The link still returns status 200, so a normal link check does not catch it.

Evidence

Measured on 2026-11-22, on the live demo, as a signed-out reader, with headless Chromium at 1280 × 900:

Link Text shown in the document "The table of contents" section shown
https://docs.plus/demo/invisible 949 characters No
https://docs.plus/demo/lights 5,672 characters Yes

Read from the repo:

  • docs/DEMO.md holds the word "invisible" 0 times.
  • docs/DEMO.md:13 lists the section as [🗂️ The table of contents](/demo/lights).
  • docs/DEMO.md:236 holds the word in that section: "the row you are reading lights up".
  • The README link came in with commit af4652aff (2026-11-03). Commit 8d4ef6057 (2026-11-05) later changed the demo text.

The fix

Change one link in README.md:51, from https://docs.plus/demo/invisible to https://docs.plus/demo/lights. No other file changes.

The maintainer asked for this fix on 2026-11-22.

Decision

  1. Which filter word should the link use? Recommended: lights, because the demo's own index line already uses it (docs/DEMO.md:13).

Not in this fix

  • A check that every demo link in README.md still matches a section of the demo. It would have caught this fault. It is a separate piece of work.
  • The other three demo links in README.md (/demo/notifications, /demo/spotify, /demo/versions). They were not measured for this issue.

Activity

  1. added this to the v2.3.7 milestone on Nov 22, 2026
  2. added
    bugSomething isn't working
    documentationImprovements or additions to documentation
    on Nov 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions