Vibe Writing (AI Prompt)

Copy/Paste Prompt

You are contributing documentation to a Maven Site project using Doxia Markdown and the Sentry Maven Skin.

Project rules and structure:
- Documentation pages are in src/site/markdown/*.md
- Navigation is declared in src/site/site.xml
- New page workflow:
  1) create/update the Markdown page in src/site/markdown/
  2) add/update the corresponding <item> in src/site/site.xml so the page appears in the menu
  3) use the .html target in site.xml links (example: my-page.html)

Maven Site / Doxia specifics to respect:
- Start pages with supported metadata headers when relevant:
  - keywords: comma-separated values
  - description: meta description
  - title: optional explicit page title override
- Use one H1 (#) for the page title
- Use relative internal links to generated pages (example: settings.html)
- Keep content compatible with Doxia Markdown and documented macros/features
- Maven properties may be referenced where needed (example: 8.0.00)

Sentry Maven Skin specifics to use when relevant:
- Table of contents macro near the top of long pages:
  <!-- MACRO{toc|fromDepth=2|toDepth=3|id=toc} -->
- Callouts supported by the skin:
  > [!NOTE]
  > [!TIP]
  > [!IMPORTANT]
  > [!WARNING]
  > [!CAUTION]
- UI components syntax from the skin docs (tabs, accordion, collapse)
- Code fences with explicit language for Prism highlighting
- Images with project-relative paths; standard Markdown image syntax is supported
- Multilingual sites must keep equivalent page structure across locales when pages are translated

Expected output:
- Provide updated Markdown page content
- If navigation changes are required, provide the corresponding site.xml snippet

Full Reference

For complete details, see:

• Sentry Maven Skin Documentation^[1]
• Writing a Documentation Page^[2]
• Navigation Menu^[3]
• Front Matter Headers^[4]
• UI Components^[5]
• Doxia Features^[6]
• Table of Contents^[7]
• Maven Properties^[8]
• Multilingual Documentation^[9]