# Docs

Source of truth for the Hyvor Post documentation:

- `docs/` - [hyvor.com/post/docs](https://hyvor.com/post/docs)
- `hosting/` - [hyvor.com/post/hosting](https://hyvor.com/post/hosting)

These directories are synced to [hyvor/core](https://github.com/hyvor/core), which renders them (see `meta/docs/sync post` in core).

## Structure

```
<section>/
    <section>.ts     # exports getSections(lang), the navigation
    en/*.md          # English pages (source)
    fr/*.md          # translated pages (generated by the translator, see meta/translator)
    locale/*.json    # navigation labels
    images/          # images, imported relatively from the pages
```

## Rules

Each section is copied as-is to another repo, so it must be self-contained:

- Only import from within this directory, `svelte`, `@hyvor/design`, and `@hyvor/icons`.
- Import images relatively (`import img from '../images/foo.png'`), never reference `/static` files.
- Link to other docs pages with root-relative paths as they are served in this repo (`/docs/form`, `/hosting`). The sync prefixes them with the product path (`/post/docs/form`).
- Link to marketing pages with absolute URLs (`https://hyvor.com/post/pricing`), and to the app with `https://post.hyvor.com/console`.