Skip to content

DX-049: Build a useful docs 404 page #561

Description

@IbrahimIjai

Context

Documentation 404s come from renamed pages and from links pasted years ago. A
bare "not found" wastes that visit; suggesting the closest existing page usually
recovers it.

Scope

  • A 404 page that keeps the sidebar and search available.
  • Suggest the closest matching pages from the requested path using string
    distance over the page index, capped at a few suggestions and only when the
    match is reasonable.
  • Offer the search dialog prefilled with terms from the path.
  • Link to the section index that the path implies, when one exists.
  • Return a real 404 status, not a 200 with 404 content.

Acceptance criteria

  • The response status is 404, verified against the built output.
  • A renamed-page path suggests the new page.
  • A nonsense path shows no misleading suggestions.
  • Search and sidebar remain functional on the 404 page.

Out of scope

  • Server-side logging of 404s.

Spec: docs/dx_1/001_docs_site.md · Depends on: DX-048

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardStellar WaveIssues in the Stellar wave programThird CampaignCampaign: Third CampaigndocumentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions