Yoda manuals

[peer35]

Pull Request Checklist

General Writing Standards

Voice and Clarity

• Text is primarily written in active voice
• Acronyms are written in full at least once on the page where they are used
• We refer to Handbook topics where possible (e.g. to the Handbook page about Yoda instead of some other information page about Yoda)

Links and Referencing

• All links use https:// protocol
• Links are descriptive (avoid "click here" links)
• For pages with a DOI, link through the DOI (e.g., https://doi.org/10.4444/xxxx)

Images

• All images have descriptive alt text

Tone and Style

• Avoid writing in the name of the handbook (no "we recommend")

Topic-Specific Standards

• Topics are nouns or noun phrases
• Topics are self-contained and concise
• Topics are title capitalized
• No include statements in topics
• Only use regular markdown (no special Quarto code)
• Where relevant, assign a suitable category

Guide-Specific Standards

• Guides are phrased as questions the reader will find answers to
• Where relevant, guides are assigned a suitable category

Checklist Usage

• Fill out this checklist when submitting a pull request
• Automated checks will verify some of these standards, but manual review is still crucial

Note to Contributors: Thank you for helping maintain the quality of our handbook!

[netlify]

✅ Deploy Preview for ubvu-open-handbook ready!

Name	Link
🔨 Latest commit	b84a36f
🔍 Latest deploy log	https://app.netlify.com/projects/ubvu-open-handbook/deploys/6877a1d606f07400087e6868
😎 Deploy Preview	https://deploy-preview-483--ubvu-open-handbook.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 20 Accessibility: 82 Best Practices: 100 SEO: 90 PWA: - View the detailed breakdown and full score reports

---

To edit notification comments on pull requests, go to your Netlify project configuration.