Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 0 additions & 52 deletions .github/workflows/algolia-index.yaml

This file was deleted.

29 changes: 0 additions & 29 deletions .github/workflows/deploy-preview.yaml

This file was deleted.

49 changes: 1 addition & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,8 @@
# Liquid Documentation

## Docs

| Doc | Directory | Sidebar |
| --- | --- | --- |
| LFM | [lfm](./lfm) | [`sidebarsLfm.ts`](./sidebarsLfm.ts) |
| LEAP | [leap](./leap) | [`sidebarsLeap.ts`](./sidebarsLeap.ts) |
| Examples | [examples](./examples) | [`sidebarsExamples.ts`](./sidebarsExamples.ts) |

## Local Development

```sh
npm install
npm run dev
```

The local server will be available at `http://localhost:3000`.

To test the build:

```sh
npm run build
npm run serve
```

The `npm run serve` script does not support hot loading.

## Search

Search is enabled by Algolia:

- Algolia crawler runs regularly on certain days within a week configured in the [crawler](https://dashboard.algolia.com/apps/NU3OWTAZ9V/crawler/crawlers).
- It also runs periodically through the [`algolia-index.yaml`](./.github/workflows/algolia-index.yaml) GitHub action, when there are changes in the `production` branch.

## Link check

There are two link checks in this repo:

- Docusaurus will throw error for any broken as configured by `onBrokenLinks` in [`docusaurus.config.ts`](./docusaurus.config.ts). If the broken build is annoying for preview, change it to `warn`.
- The [`check.yaml`](./.github/workflows/check.yaml) workflow has a `check-link` job that examine markdown links. Customize the config in [`link-check.json`](./link-check.json). If a link cannot be accessed (e.g. Github private repo), add the URL pattern to the `ignorePatterns` array.

## Deployment

The deployment is automated through Vercel.

| Branch | Domain |
| ------------ | ------------------------------- |
| `main` | https://docs-staging.liquid.ai/ |
| `production` | https://docs.liquid.ai/ |

To promote the `main` branch to `production`, run the [`deploy-main.yaml`](https://github.com/Liquid4All/docs/actions/workflows/deploy-main.yaml) GitHub action, which will automatically fast-forward the `production` branch to match `main`.
The [`check.yaml`](./.github/workflows/check.yaml) workflow has a `check-link` job that examine markdown links. Customize the config in [`link-check.json`](./link-check.json). If a link cannot be accessed (e.g. Github private repo), add the URL pattern to the `ignorePatterns` array.

## LICENSE

Expand Down