Skip to content

[Design] Add contextual in-app documentation #422

Description

@KacperKozak

Vescape needs contextual documentation inside the app. Features with behavior that is not obvious should be able to show a small "How this works" link or button. It should open a native drawer with short, readable documentation without sending the rider to a website.

Build this as a Core UI feature that any app module can use. Each module should own its guide copy. The shared component should own presentation, scrolling, dismissal, and accessibility.

Group Ride is the first adoption point because riders need to understand discovery, location sharing, joining, stale riders, and what happens when they leave.

Likely files

  • src/components/overlays/EdgeDrawer.tsx - existing native drawer behavior to reuse
  • src/components/base/Markdown.tsx - existing native renderer for structured local content
  • src/app/settings/components/markdown.tsx - current Markdown examples and visual preview
  • src/app/settings/components/modals.tsx - shared drawer previews and controls
  • src/modules/group-ride/components/SocialSheet.tsx - first feature to adopt the shared help UI
  • docs/adr/0020-group-ride-server-relayed-native-presence.md - source of truth for the first guide's behavior and privacy copy
  • docs/design.md - app layout, typography, and interaction rules

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:designDesign system, theme, and color tokensarea:group-rideGroup Rides: live shared rides, Rider presence, relay servercomplexity:lowIsolated, hard to break other things. Use sonnet/haiku.enhancementNew feature or requestnice-to-haveready-for-agentFully specified, ready for an AFK agent

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions