wehub-resource-sync
4b6817381b
CI (OpenClaw E2E) / openclaw test (push) Has been cancelled
CI / coverage-report (push) Has been cancelled
CI / test-kubernetes (push) Has been cancelled
CI / should-run-thorough (push) Has been cancelled
CI / test-thorough (cloudwatch-demo) (push) Has been cancelled
CI / test-thorough (flink-ecs) (push) Has been cancelled
CI / test-thorough (upstream-lambda) (push) Has been cancelled
CI / test-thorough (prefect-ecs-fargate) (push) Has been cancelled
Release / build-binaries (zip, opensre.exe, onefile, windows-latest, windows-x64) (push) Has been cancelled
Benchmark image — build + push to ECR (any adapter) / build + push (push) Has been cancelled
CI / quality (ubuntu-latest) (push) Has been cancelled
CI / test (tools-runtime) (push) Has been cancelled
CI / test (e2e-general) (push) Has been cancelled
CI / test (cli-runtime) (push) Has been cancelled
CI / test (e2e-provider-and-openclaw) (push) Has been cancelled
CI / test (integrations-and-misc) (push) Has been cancelled
Release / verify (push) Has been cancelled
Release / build-python-dist (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, macos-15-intel, darwin-x64) (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, macos-latest, darwin-arm64) (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, ubuntu-22.04, linux-x64) (push) Has been cancelled
Release / publish-release (push) Has been cancelled
Release / publish-main-release (push) Has been cancelled
Interactive Shell Live (PR + post-merge) / turn-checks (no-LLM) (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
Interactive Shell Live (PR + post-merge) / turn-live shard ${{ matrix.shard_index }} (push) Has been cancelled
Release / prepare (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, ubuntu-22.04-arm, linux-arm64) (push) Has been cancelled
Synthetic Deterministic Tests / Synthetic offline (deterministic) (push) Has been cancelled
54 lines
1.3 KiB
Markdown
54 lines
1.3 KiB
Markdown
# OpenSRE Documentation
|
|
|
|
This directory contains the source for the OpenSRE documentation, powered by [Mintlify](https://mintlify.com).
|
|
|
|
## Local Development
|
|
|
|
To preview the documentation locally, you need to install the Mintlify CLI.
|
|
|
|
### Prerequisites
|
|
|
|
- [Node.js](https://nodejs.org/) (version 18 or higher)
|
|
- [npm](https://www.npmjs.com/)
|
|
|
|
### Setup
|
|
|
|
1. Install the Mintlify CLI globally:
|
|
|
|
```bash
|
|
npm i -g mint
|
|
```
|
|
|
|
2. Run the development server from this directory:
|
|
|
|
```bash
|
|
mint dev
|
|
```
|
|
|
|
Alternatively, from the project root, you can run:
|
|
|
|
```bash
|
|
make docs-dev
|
|
```
|
|
|
|
The documentation will be available at `http://localhost:3000`.
|
|
|
|
## Structure
|
|
|
|
- `docs.json`: Configuration file for the documentation, including navigation and theme settings.
|
|
- `*.mdx`: Documentation pages written in MDX (Markdown with JSX).
|
|
- `images/`: Static assets such as screenshots and diagrams.
|
|
- `snippets/`: Reusable content blocks.
|
|
|
|
## Contributing
|
|
|
|
1. Create a new branch for your changes.
|
|
2. Edit the relevant `.mdx` files or update `docs.json` if adding new pages.
|
|
3. Preview your changes locally using `mint dev`.
|
|
4. Submit a Pull Request with a clear description of your changes.
|
|
|
|
## Resources
|
|
|
|
- [Mintlify Documentation](https://mintlify.com/docs)
|
|
- [MDX Syntax Guide](https://mdxjs.com/docs/what-is-mdx/)
|