Spaces:
Running on CPU Upgrade
Running on CPU Upgrade
Commit ·
4a65a6b
1
Parent(s): 6208f27
added some learnings to agents.md
Browse files
AGENTS.md
CHANGED
|
@@ -34,6 +34,7 @@ Use these blog posts as inspiration for writing style:
|
|
| 34 |
- **Inline code** for technical identifiers: model names, hyperparameters, file paths
|
| 35 |
- Lists for features, steps, or comparisons
|
| 36 |
- Keep paragraphs short (3-5 sentences max)
|
|
|
|
| 37 |
|
| 38 |
## Structure
|
| 39 |
|
|
@@ -48,10 +49,12 @@ Use these blog posts as inspiration for writing style:
|
|
| 48 |
- Concrete examples over abstract explanations
|
| 49 |
- Show, don't tell: prefer an interactive demo over a paragraph of description
|
| 50 |
- Link to sources, don't just cite them
|
|
|
|
| 51 |
|
| 52 |
## Interactivity
|
| 53 |
|
| 54 |
- Treat figures as first-class content, not decoration
|
|
|
|
| 55 |
- Interactive elements should reveal insight, not just look fancy
|
| 56 |
- Ensure all visualizations work in dark mode
|
| 57 |
- Mobile-friendly is mandatory
|
|
@@ -115,6 +118,7 @@ The bibliography file is organized into these sections (in order). Always place
|
|
| 115 |
| `<Glossary>` | Hover definitions for terms |
|
| 116 |
| `<Quote>` | Attributed quotations |
|
| 117 |
| `<Stack>` | Multi-column layouts |
|
|
|
|
| 118 |
|
| 119 |
## Chart Selection
|
| 120 |
|
|
|
|
| 34 |
- **Inline code** for technical identifiers: model names, hyperparameters, file paths
|
| 35 |
- Lists for features, steps, or comparisons
|
| 36 |
- Keep paragraphs short (3-5 sentences max)
|
| 37 |
+
- **Minimize horizontal scrolling in tables**: If a table row has long content that causes horizontal overflow, convert it to a bullet list or restructure the information. Prefer lists over tables when rows have variable-length prose
|
| 38 |
|
| 39 |
## Structure
|
| 40 |
|
|
|
|
| 49 |
- Concrete examples over abstract explanations
|
| 50 |
- Show, don't tell: prefer an interactive demo over a paragraph of description
|
| 51 |
- Link to sources, don't just cite them
|
| 52 |
+
- **Never show plain URLs as link text**: Always integrate links into descriptive text (e.g., write `[DataTrove inference benchmark](https://github.com/...)` not `[github.com/huggingface/datatrove/...](https://github.com/...)`)
|
| 53 |
|
| 54 |
## Interactivity
|
| 55 |
|
| 56 |
- Treat figures as first-class content, not decoration
|
| 57 |
+
- **All images/plots must be wrapped as figures** (using `<figure>` with `id` and `<figcaption>`) and every figure must be mentioned in the surrounding text using `<FigRef target="figure-id" />`. Do NOT include "Figure N:" in `<figcaption>` text since the figure environment auto-numbers
|
| 58 |
- Interactive elements should reveal insight, not just look fancy
|
| 59 |
- Ensure all visualizations work in dark mode
|
| 60 |
- Mobile-friendly is mandatory
|
|
|
|
| 118 |
| `<Glossary>` | Hover definitions for terms |
|
| 119 |
| `<Quote>` | Attributed quotations |
|
| 120 |
| `<Stack>` | Multi-column layouts |
|
| 121 |
+
| `<FigRef>` | Auto-numbered figure cross-references (e.g., `<FigRef target="my-figure-id" />` renders as "Figure 3") |
|
| 122 |
|
| 123 |
## Chart Selection
|
| 124 |
|