Skip to content

Create internal documentation site #109

@parsakhaz

Description

@parsakhaz

Problem

Pane has no user-facing documentation site. Features like pane.json config detection, run script resolution hierarchy, and project settings have no external docs to link to. The in-app help dialog covers basics but doesn't provide detailed guides.

Proposed Solution

Create a documentation repository/site using a modern docs framework:

  • Astro Starlight, Docusaurus, VitePress, or Nextra — whichever fits best
  • Host on GitHub Pages or Vercel
  • Cover: getting started, pane.json format, config file detection, project settings, keyboard shortcuts, troubleshooting
  • Link from within the app (help dialog, setup dialogs, tooltips)

Context

This was identified during the pane.json config detection work (#107) and the run script setup dialog (#108) — both features need documentation pages to link to.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    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