Objective
Link technical jargon to glossary definitions on first use and consider adding inline tooltips to reduce beginner confusion.
Context
Testing identified multiple terms that confuse beginners:
- "Agentic" (used throughout before being defined)
- "Frontmatter" (used before explaining what it is)
- "MCP" (acronym never expanded on first use)
- "Engine" (not clear this means "which AI to use")
- "Safe outputs" (sounds scary, not explained simply)
- "Lock.yml" (relationship to .md file not immediately clear)
Current State
Terms are defined in the glossary but not linked from pages where they're first introduced.
Approach
- Audit all documentation pages for jargon terms
- Add markdown links to glossary on first use of each term
- Expand acronyms on first use: "Model Context Protocol (MCP)"
- Consider adding Astro Starlight tooltips or asides for key terms
- Add brief inline explanations for critical concepts
Example Changes
Before:
Configure your engine and frontmatter...
After:
Configure your [engine](/glossary#engine) (which AI to use) and [frontmatter](/glossary#frontmatter) (configuration at the top of your file)...
Or with Starlight aside:
:::tip[What is frontmatter?]
Frontmatter is the configuration section at the top of your workflow file, between `---` markers.
:::
Files to Modify
Key pages to update:
docs/src/content/docs/guides/creating-workflows.mdx
docs/src/content/docs/guides/quickstart.mdx
docs/src/content/docs/index.mdx
- Any example pages that introduce concepts
docs/src/content/docs/reference/glossary.mdx (ensure all terms are present)
Acceptance Criteria
AI generated by Plan Command for discussion #8477
Objective
Link technical jargon to glossary definitions on first use and consider adding inline tooltips to reduce beginner confusion.
Context
Testing identified multiple terms that confuse beginners:
Current State
Terms are defined in the glossary but not linked from pages where they're first introduced.
Approach
Example Changes
Before:
After:
Or with Starlight aside:
Files to Modify
Key pages to update:
docs/src/content/docs/guides/creating-workflows.mdxdocs/src/content/docs/guides/quickstart.mdxdocs/src/content/docs/index.mdxdocs/src/content/docs/reference/glossary.mdx(ensure all terms are present)Acceptance Criteria