Skip to content

Website docs: improve navigation, accuracy, and command discovery #159

Description

@SarthakWade

Problem

The docs site is source-backed and visually consistent, but navigation depends on positional route slicing, command discovery is limited, and the overview incorrectly describes sessions as isolated even though normal sessions share cookies and storage.

Scope

  • Replace positional route slicing with explicit navigation categories.
  • Correct the session-isolation language using the documented profile contract.
  • Add searchable or filterable command discovery without duplicating command definitions.
  • Add stable section anchors, an in-page table of contents where useful, and clearer current-section state.
  • Improve mobile navigation and keyboard accessibility while retaining the current typography, language, and visual system.
  • Reserve Settings, Credentials, Profiles, and SDK sections, but publish claims only when their contracts ship.

Constraints

README, COMMANDS, SECURITY, phase contracts, package metadata, and benchmark results remain authoritative. New rendered claims must pass provenance validation. Do not add a parallel hand-maintained documentation source or redesign the site.

Acceptance criteria

  • Every docs route is categorized explicitly and remains reachable on desktop and mobile.
  • Search/filter behavior is keyboard accessible and tested.
  • The inaccurate isolation claim is removed.
  • Source-provenance validation rejects stale or duplicated feature claims.
  • Web lint, build, responsive checks, and accessibility-focused tests pass.

Activity

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

    area:webapps/web marketing and docs sitepriority:mediumScheduled, not blockingtype:docsDocumentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions