Documentation / Get started

Introduction

What Glyph does and when to use it.

What is Glyph?

Glyph is a frontend design skill for coding assistants. It helps an assistant understand a product, choose a visual direction, compose the important screen, implement the interface and inspect what it built.

Install one Markdown entry point with focused references. There is no Glyph API key or background service. Your assistant reads the guidance relevant to the task.

Glyph guides judgment. It does not prescribe the same font, palette, hero or component grid for every product.

How to think about it

Product first
Start with the audience, content and primary task. Preserve an established brand unless a redesign is requested.
Composition before polish
Resolve hierarchy, density and proportions before spending time on button shadows.
Personality with purpose
Typography, color, imagery and interaction can all carry identity. Simple does not have to mean lifeless.
Evidence over appearance
Inspect actual screens and behavior. A successful build is one check, not proof of a finished experience.

Start building

Guides & section titles

IntroductionWhat Glyph does and when to use it.What is Glyph?IntroductionHow to think about itIntroductionStart buildingIntroductionInstallationAdd Glyph to your coding assistant.Install with the skills CLIInstallationInstall from a local checkoutInstallationVerify the installationInstallationDesign workflowFrom understanding the product to inspecting the result.Understand and chooseDesign workflowCompose and expressDesign workflowBuild and interactDesign workflowVerify and reviseDesign workflowCommands & promptsWays to ask your assistant to use Glyph.Request conventionsCommands & promptsAn example briefCommands & promptsGuidance & exceptionsUnderstand requirements, patterns and design judgment.Instruction rolesGuidance & exceptionsWhen to break a patternGuidance & exceptionsResearch with referencesGuidance & exceptionsSkill filesRead the actual Markdown included in the skill.Explore the sourceSkill filesLoad guidance selectivelySkill filesCustomizationAdapt Glyph to your brand and project.Bring your own directionCustomizationWrite useful constraintsCustomizationTroubleshootingResolve installation, discovery and output issues.The assistant cannot find GlyphTroubleshootingThe result feels genericTroubleshootingCopy or theme is unavailableTroubleshootingVerificationCheck the implementation and report evidence honestly.Before shippingVerificationEvaluating the skillVerificationCurrent evidence limitsVerificationSources & licenseAttribution, license and reference use.Source acknowledgmentsSources & licenseMIT licenseSources & license
Tab to move · Enter to open · Esc to close