This is your introduction paragraph. Start with a hook or summary of what you're discussing. Keep it conversational but technical. Reference the problem you're solving or the insight you're sharing.
Section One
Body paragraphs go here. Use simple, readable language. Break up longer ideas into multiple paragraphs. The monospace font makes things feel technical naturally.
Continue your narrative. You can reference code, concepts, or research inline.
Subsection
Smaller subsections for breaking down complex topics. Keep the hierarchy flat— no more than two levels deep.
Code Examples
For code snippets, use the code block below:
static inline void folio_alias_check(struct folio *folio)
{
if (unlikely(folio->flags & FOLIO_ALIASED)) {
pr_warn("Memory aliasing detected\n");
dump_stack();
}
}
Explain what the code does and why it matters. Keep code blocks short (10–20 lines).
Quotes & Callouts
Use blockquotes for emphasis or to attribute ideas:
"The page cache is responsible for more memory safety issues than most developers realize. Understanding how aliasing breaks the assumptions is critical for kernel work."
Follow up with context about why this quote matters.
Lists
You can use lists for clarity:
- First key point or finding
- Second observation with supporting detail
- Third conclusion or takeaway
Conclusion
Wrap up with a summary of what you covered and why it matters. Point readers to related work, next steps, or open questions. Keep it brief—2–3 sentences max.