Styleguides — eloqnt/studio

A styleguide is free-form markdown document that steers aspects like tone, terminology, and consistency. You write what is specific to your project, and eloqnt/engine layers on translation best practices automatically.

`styleguide.md`

Applies to every locale and contains overall guidance.

.eloqnt/styleguide.md

# Styleguide

## Audience

A few sentences about who your users are and how your site/app serves them.

## Voice and tone

- Friendly and concise.
- Address the user as "you", and prefer active voice.

## Do not translate

- eloqnt
- API key

Styleguides are self-contained. eloqnt/engine doesn't follow local or external links inside them, so any guidance the engine needs must live in the file itself.

If you want to share styleguides across packages and apps—for example in a monorepo—you can symlink them where relevant.

`styleguide.<locale>.md`

Layers on top of the global styleguide and takes precedence wherever the two conflict.

.eloqnt/styleguide.es.md

# `es` styleguide

## Tone

- Use informal "tú", never formal "usted".
- Use straight quotation marks (`"…"`), not Spanish guillemets.

## Glossary

- "dashboard": "panel"