DoDont
Side-by-side recommended versus avoid pattern for style guides, API usage notes, onboarding docs, and prompt writing.
For isolated previews, theme switching, and sandbox editing, open the DoDont playground on holydocs.com .
When to use
Use this component when you need stronger document structure, annotation, or narrative pacing inside a page.
Live Examples
Every example below renders the real component directly inside HolyDocs, followed by the exact MDX you can paste into a page.
Prompt Writing
Clear guidance for good and bad prompt patterns.
Be explicit about the outcome
Ask for the exact format, constraints, and source material you want the assistant to use.
Leave the task underspecified
Vague requests force the reader or model to guess, which usually means inconsistent output and longer iteration loops.
mdx<DoDont> <Do title="Be explicit about the outcome"> Ask for the exact format, constraints, and source material you want the assistant to use. </Do> <Dont title="Leave the task underspecified"> Vague requests force the reader or model to guess, which usually means inconsistent output and longer iteration loops. </Dont></DoDont>
Props
This component has no configurable props. Use its child content to shape the output.
Usage
Start from this baseline shape and then tailor the copy, data, or nesting to the page you are writing.
mdx<DoDont> <Do title="Be explicit about the outcome"> Ask for the exact format, constraints, and source material you want the assistant to use. </Do> <Dont title="Leave the task underspecified"> Vague requests force the reader or model to guess, which usually means inconsistent output and longer iteration loops. </Dont></DoDont>
Tips
- Keep the surrounding copy short so the component remains the focal point instead of becoming redundant chrome.
- Prefer one clear job per component instance. If a block is trying to explain, navigate, and warn at the same time, split it up.
- Check the page in both light and dark mode when you stack multiple content components together. Dense compositions can feel heavier than expected.
Related Components
Highlighted message blocks for drawing attention to notes, tips, warnings, and other contextual information.
More
- Interactive playground: DoDont on holydocs.com
- Component library index: /components