Skip to content

Fix README "Documentation" link text/href mismatch (line 154) #87

Description

@se-jo-ma

Context

README.md line 154 reads:

Full documentation is available at [nautilus.krakn.ai](https://krakennet.github.io/nautilus/).

The visible link text (nautilus.krakn.ai) does not match its actual href (krakennet.github.io/nautilus/). A reader who copies the displayed text lands on a different host than where the link points.

This surfaces a real canonical-domain inconsistency across the repo:

  • docs/CNAME and pyproject.toml (Documentation URL) declare nautilus.krakn.ai
  • mkdocs.yml site_url, the README Docs badge (line 9), and every other README doc link use krakennet.github.io/nautilus

Task

Make the link text and href on README line 154 refer to the same host. The safe beginner fix is to change the display text to match the href already used everywhere else in the README (krakennet.github.io/nautilus). Do NOT attempt to resolve which domain is canonical — flag that for a maintainer in the PR description.

Where

  • /home/sean/leagues/nautilus/README.md line 154 (the fix)
  • /home/sean/leagues/nautilus/docs/CNAME line 1 — nautilus.krakn.ai (conflict context)
  • /home/sean/leagues/nautilus/pyproject.toml line 47 — Documentation = "https://nautilus.krakn.ai" (conflict context)
  • /home/sean/leagues/nautilus/mkdocs.yml line 3 — site_url: https://krakennet.github.io/nautilus (conflict context)

Acceptance criteria

  • On README line 154, the link's display text and its URL refer to the same host.
  • No new doubled-slash is introduced (note: lines 156-159 already contain nautilus//... doubled slashes — that is a separate task; do not touch those here unless instructed).
  • PR description notes the unresolved krakn.ai vs github.io canonical-domain inconsistency for a maintainer to decide.

First-timer notes

Start at /home/sean/leagues/nautilus/README.md line 154. The fix is editing the bracketed link text [nautilus.krakn.ai] so it reads the host inside the parentheses. No build, test, or code knowledge is needed — this is a single-line Markdown edit. Open docs/CNAME, pyproject.toml, and mkdocs.yml only to understand why you should NOT silently pick a domain; mention the conflict in your PR.

Size: XS

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3Low priority: doc hygiene, cosmeticarea/docsDocumentation sitedocumentationDocumentation improvementsgood first issueGood for newcomers — scoped, no deep codebase knowledge neededhelp wantedMaintainers would welcome a contributor heresize/XS<1hr: trivial fix or doc tweak

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions