#Contributor Guide

Welcome to the Lynx website contributor guide! This documentation project is a large-scale repository that powers the official Lynx documentation. To help you navigate and contribute effectively, we've organized the guidelines into specific topics.

Whether you are writing a blog post, updating API documentation, or adding a new example, this guide will help you understand the tools and conventions we use.

#Catalog

#✍️ Writing

• Guides - Best practices for page configuration, frontmatter, and writing platform-specific content.
• Example - How to add and embed interactive examples using lynx-example-packages.
• Blog - How to write and publish blog posts.
• Spec - Guide to editing the Lynx Living Specification.

#📚 Managing API

• API Reference - The source of truth for API references. Learn about lynx-compat-data, <APITable>, and generating docs with TypeDoc.
• API Status - Guide for using the API Status Dashboard tool.

#🎨 Website UI

• Subsites - Understanding how the site handles multiple languages and contexts (subsites).
• MDX Components References - A "Storybook-style" reference for using built-in components like badges, callouts, and tabs.