Skip to content

checklist.md

Latest commit

 

History

History
28 lines (23 loc) · 2.3 KB

checklist.md

File metadata and controls

28 lines (23 loc) · 2.3 KB
Raw

Documentation Standards Compliance Checklist

Blank Slate Mandate

  • quickstart/page.mdx: Added prerequisites section with OS, Python, Node.js, and curl versions (Lines 25-45)
  • quickstart/chat_completion_tab/_page.mdx: Added prerequisites section with OS, Python, Node.js, and curl versions (Lines 7-37)
  • clients/page.mdx: Added prerequisites section with OS, Python, and Node.js versions (Lines 25-45)
  • clients/python_sdk_tab/_page.mdx: Added prerequisites section with OS and Python versions (Lines 7-27)

Zero Dead Ends Requirement

  • quickstart/page.mdx: Added "Next Steps" section with three hyperlinks (Lines 75-80)
  • quickstart/chat_completion_tab/_page.mdx: Added "Next Steps" section with three hyperlinks (Lines 45-50)
  • clients/page.mdx: Added "Next Steps" section with three hyperlinks (Lines 50-55)
  • clients/python_sdk_tab/_page.mdx: Added "Next Steps" section with three hyperlinks (Lines 50-55)

Fail Safely and Loudly Protocol

  • No destructive commands found in the reviewed files

3-Second Rule

  • quickstart/page.mdx: First H1 heading is "Quickstart" and the first paragraph states the problem solved (Lines 20-25)
  • quickstart/chat_completion_tab/_page.mdx: First H1 heading is "Chat Completion" and the first paragraph states the problem solved (Lines 3-7)
  • clients/page.mdx: First H1 heading is "SDK Clients" and the first paragraph states the problem solved (Lines 20-25)
  • clients/python_sdk_tab/_page.mdx: First H1 heading is "Python SDK" and the first paragraph states the problem solved (Lines 3-7)

Extreme Scannability Specification

  • quickstart/page.mdx: Maximum paragraph length is 3 sentences, descriptive subheadings every 200-250 words, bold text and code blocks used (Lines 25-70)
  • quickstart/chat_completion_tab/_page.mdx: Maximum paragraph length is 3 sentences, descriptive subheadings every 200-250 words, bold text and code blocks used (Lines 7-45)
  • clients/page.mdx: Maximum paragraph length is 3 sentences, descriptive subheadings every 200-250 words, bold text and code blocks used (Lines 25-50)
  • clients/python_sdk_tab/_page.mdx: Maximum paragraph length is 3 sentences, descriptive subheadings every 200-250 words, bold text and code blocks used (Lines 7-50)