docs: quote YAML frontmatter values with colons#15
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses and resolves several Vale linting failures by standardizing the formatting of YAML frontmatter and content within documentation files. The changes primarily involve quoting string values that contain special characters like colons and expanding abbreviations to ensure compliance with established documentation guidelines, thereby improving the overall consistency and validity of the documentation. Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request correctly addresses YAML frontmatter parsing issues by quoting values that contain colons, which is crucial for correct parsing. The changes also standardize on using single quotes for strings, improving consistency. I have one suggestion to improve the formatting of a long list of tags for better readability and consistency.
| tags: | ||
| [imessage, imsg, macos, legacy, pairing, groups, attachments, ssh, tailscale] |
There was a problem hiding this comment.
For consistency with other files and for better readability, it's better to format this long list of tags as a standard YAML block sequence. This is more conventional for multi-line lists.
tags:
- imessage
- imsg
- macos
- legacy
- pairing
- groups
- attachments
- ssh
- tailscale
There was a problem hiding this comment.
Pull request overview
This PR updates Datzi docs frontmatter/content to address Vale lint failures by quoting YAML values that contain colons and adjusting wording to comply with style rules.
Changes:
- Quote YAML frontmatter
title/summaryvalues containing colons. - Normalize some frontmatter quoting and tag list formatting.
- Update wording in at least one concept summary (e.g., “e.g.” → “for example”) to satisfy a Vale rule.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| datzi/concepts/session.mdx | Quotes summary frontmatter value containing agent:<...>:<...>. |
| datzi/concepts/multi-agent.mdx | Quotes summary and normalizes tags quoting. |
| datzi/concepts/model-failover.mdx | Quotes summary containing a colon. |
| datzi/concepts/agent-loop.mdx | Quotes summary containing a colon and arrow sequence. |
| datzi/channels/imessage.mdx | Quotes title containing a colon and reformats tags frontmatter. |
| datzi/automation/cron-vs-heartbeat.mdx | Quotes title containing a colon. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| slug: model-failover | ||
| title: Model failover | ||
| summary: Datzi handles failures in two stages:. | ||
| summary: 'Datzi handles failures in two stages:.' |
| title: Agent Loop (Datzi) | ||
| summary: An agentic loop is the full “real” run of an agent: intake → context assembly → model inference →. | ||
| tags: ["concepts", "agent", "loop"] | ||
| summary: 'An agentic loop is the full “real” run of an agent: intake → context assembly → model inference →.' |
| tags: | ||
| [imessage, imsg, macos, legacy, pairing, groups, attachments, ssh, tailscale] |
| slug: session | ||
| title: Session Management | ||
| summary: Datzi treats **one direct-chat session per agent** as primary. Direct chats collapse to agent:<agentId>:<mainKey> (. | ||
| summary: 'Datzi treats **one direct-chat session per agent** as primary. Direct chats collapse to agent:<agentId>:<mainKey> (.' |
| title: Multi-Agent Routing | ||
| summary: Goal: multiple *isolated* agents (separate workspace + agentDir + sessions), plus multiple channel accounts (e.g. two. | ||
| tags: ["concepts", "multi", "agent"] | ||
| summary: 'Goal: multiple *isolated* agents (separate workspace + agentDir + sessions), plus multiple channel accounts (for example two.' |
| title: Multi-Agent Routing | ||
| summary: Goal: multiple *isolated* agents (separate workspace + agentDir + sessions), plus multiple channel accounts (e.g. two. | ||
| tags: ["concepts", "multi", "agent"] | ||
| summary: 'Goal: multiple *isolated* agents (separate workspace + agentDir + sessions), plus multiple channel accounts (for example two.' |
Follow-up to fix Vale lint failures from PR #13.\n\nChanges:\n- Quote YAML frontmatter values with colons.\n- Quote values with colons in concept docs.\n- Replace with in to satisfy Microsoft.Foreign rule.