Skip to content

Problem Description

The file readme.md is the description students read when they open the problem. It's shown next to the code editor.

Editing

Open readme.md from the file sidebar. The editor shows a live Markdown preview on the left as you type. Press Ctrl+S to save. You can also edit it in the Description box on the manage page, or ask the assistant to write it.

Format

Write in Markdown. Common syntax:

# Big heading

## Smaller heading

Normal paragraph text.

- Bullet point
- Another bullet point

**Bold** and _italic_.

`inline code`

    indented code block (4 spaces)

What to include

Function name — tell students the exact name they must implement. It must match the problem's function-name contract.

Examples — one or two input/output pairs are easier to understand than prose.

Constraints — any libraries they can't use, input ranges, edge cases they should handle.

Example

# Add Two Numbers

Write a function called `add` that takes two numbers and returns their sum.

## Example

add(1, 2)  → 3
add(5, 5)  → 10

## Rules

- No libraries
- Function must be named `add`

Tips

  • Short is better. Students are there to code.
  • Show examples rather than explain in words.
  • Repeat the function name. Students often miss it.