Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 1.44 KB

README.md

File metadata and controls

28 lines (19 loc) · 1.44 KB

Docs Index

Use this file to choose the smallest useful doc. Prefer focused maps before full references.

Preferred Entry Points

  • parser-map.md - script metadata parsing, attributes, parameters, manifest models, and compatibility gates.
  • execution-map.md - process launch, timeouts, output capture, clipboard/open/file side effects, and failure reporting.
  • ui-map.md - Command Palette pages, forms, settings, pinning, script creation, and context commands.
  • PaletteShellScripts.AGENTS.md - short guide for writing PaletteShell .ps1 scripts.

Full References

  • ExtensionReference.md - index for split extension references.
  • user-guide.md - user-facing overview, setup flow, samples, community links, and help.
  • extension-behavior-reference.md - discovery, parsing, routing, output behavior, pinning, and settings.
  • project-structure-reference.md - build-from-source summary and file responsibility table.
  • PaletteShellScripts.Reference.md - full script authoring contract; avoid unless exact attribute, output mode, form mapping, or input-design rules are needed.

Root Docs

  • ../AGENTS.md - repo-level agent routing and validation commands.
  • ../README.md - short product overview.
  • ../CONTRIBUTING.md - build, test, debugging, packaging, and contribution workflow.

Rule Of Thumb

Open one focused map first, inspect source files next, and only then open a full reference if the focused map does not answer the question.