User Guide Pages
Style and structure guidelines for writing pages that introduce extendr-api features.
User guide pages are friendly introductions to specific features of the
extendr-api crate. Keep them concise and use simple language.
Always use code chunks for extendr code — never paste raw snippets.
Page structure
Each page should follow this rough structure:
---
title "An informative title"
---
- Motivate the functionality the page covers
- No more than 4 sentences
## The feature
- Describe the functionality
- Discuss prerequisites if any
## Basic usage
- Discuss the code before showing it
```{.rust}
// your Rust code
```
- Summarize and explain the output
## Advanced usage
- Motivate the advanced example
```{.rust}
// your Rust code
```
- Summarize and explain
## See also
- Links to related pages or external docs