Documentation should be written with the user's perspective in mind, using clear, action-oriented language and intuitive organization. Follow these principles:
Documentation should be written with the user’s perspective in mind, using clear, action-oriented language and intuitive organization. Follow these principles:
Example:
- ## Overview
- The component can be configured with various options that are found in the API documentation.
+ ## How do I configure the component?
+ You can customize the component using these key options:
+
+ 1. Set the `variant` prop to change the visual style
+ 2. Use the `size` prop to adjust dimensions
+ 3. Add the `disabled` prop to control interactivity
+
+ ```jsx
+ // Complete, ready-to-use example
+ import { Button } from '@mui/material';
+
+ export default function CustomButton() {
+ return (
+ <Button
+ variant="contained"
+ size="large"
+ disabled={false}
+ >
+ Click me
+ </Button>
+ );
+ }
+ ```
Enter the URL of a public GitHub repository