Skip to content

REVIEW.md

Latest commit

 

History

History
12 lines (10 loc) · 1.06 KB

REVIEW.md

File metadata and controls

12 lines (10 loc) · 1.06 KB

PR Review Guidelines

Please check the following:

  • Edited text is grammatically correct (American English)
  • Edited text has consistent punctuation
  • Code blocks in core documentation include all imports to be self-contained (does not apply to notebooks/cookbooks)
  • If blocks of text or code are largely repeated on multiple documentation pages, suggest to consolidate them in components-mdx to improve maintainability and consistency.
  • When embedding videos from youtube, make sure to embed from https://www.youtube-nocookie.com instead of https://www.youtube.com to avoid cookies and tracking.
  • Use one H1 per markdown file, with subsections in order (##, ###, etc.)—do not skip heading levels.
  • We never use .gif files, only .mp4 files uploaded to static.langfuse.com/docs-videos to optimize for size and performance.
  • when deeplinking to a section via a link that uses the # anchor, make sure that this the anchor for this section is explicitly defined in the source page via [#anchor] at the end of the header line, e.g. ## Get Started [#get-started]