mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-08-29 03:36:29 +08:00
docs: replace root-relative cross links with relative page links (#18664)
configurations.md and backup_and_migration.md cross-linked each other via /migration#... and /configurations#s3-tigris. These host-absolute paths match no route on the docs site (real pages live under /administrator/...) and 404 on GitHub. Point them at the sibling markdown files so both Docusaurus and GitHub can resolve them; the existing anchors are preserved. --------- Co-authored-by: jindou <jindou@local> Co-authored-by: Jin Hai <haijin.chn@gmail.com>
This commit is contained in:
24
README_ar.md
24
README_ar.md
@@ -57,19 +57,19 @@
|
||||
<details open>
|
||||
<summary><b>📕 جدول المحتويات</b></summary>
|
||||
|
||||
- 💡 [ما هو RAGFlow؟](#-what-is-ragflow)
|
||||
- 🎮 [ابدأ](#-get-started)
|
||||
- 📌 [آخر التحديثات](#-latest-updates)
|
||||
- 🌟 [الميزات الرئيسية](#-key-features)
|
||||
- 🔎 [بنية النظام](#-system-architecture)
|
||||
- 🎬 [الاستضافة الذاتية](#-self-hosting)
|
||||
- 🔧 [التكوينات](#-configurations)
|
||||
- 🔧 [إنشاء صورة Docker](#-build-a-docker-image)
|
||||
- 🔨 [إطلاق الخدمة من المصدر للتطوير](#-launch-service-from-source-for-development)
|
||||
- 📚 [التوثيق](#-documentation)
|
||||
- 💡 [ما هو RAGFlow؟](#-ما-هو-ragflow)
|
||||
- 🎮 [ابدأ](#-ابدأ)
|
||||
- 📌 [آخر التحديثات](#-آخر-التحديثات)
|
||||
- 🌟 [الميزات الرئيسية](#-الميزات-الرئيسية)
|
||||
- 🔎 [بنية النظام](#-هندسة-النظام)
|
||||
- 🎬 [الاستضافة الذاتية](#-الاستضافة-الذاتية)
|
||||
- 🔧 [التكوينات](#-التكوينات)
|
||||
- 🔧 [إنشاء صورة Docker](#-أنشئ-صورة-docker)
|
||||
- 🔨 [إطلاق الخدمة من المصدر للتطوير](#-إطلاق-الخدمة-من-المصدر-للتطوير)
|
||||
- 📚 [التوثيق](#-التوثيق)
|
||||
- 📜 [Roadmap](#-roadmap)
|
||||
- 🏄 [المجتمع](#-community)
|
||||
- 🙌 [مساهمة](#-contributing)
|
||||
- 🏄 [المجتمع](#-المجتمع)
|
||||
- 🙌 [مساهمة](#-المساهمة)
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
@@ -67,7 +67,7 @@
|
||||
- 🔧 [Construire une image Docker](#-construire-une-image-docker)
|
||||
- 🔨 [Lancer le service depuis les sources pour le développement](#-lancer-le-service-depuis-les-sources-pour-le-développement)
|
||||
- 📚 [Documentation](#-documentation)
|
||||
- 📜 [Roadmap](#-feuille-de-route)
|
||||
- 📜 [Roadmap](#-roadmap)
|
||||
- 🏄 [Communauté](#-communauté)
|
||||
- 🙌 [Contribuer](#-contribuer)
|
||||
|
||||
|
||||
@@ -65,9 +65,9 @@
|
||||
- 🎬 [Pengelolaan Mandiri](#-pengelolaan-mandiri)
|
||||
- 🔧 [Konfigurasi](#-konfigurasi)
|
||||
- 🔧 [Membangun Image Docker](#-membangun-docker-image)
|
||||
- 🔨 [Meluncurkan aplikasi dari Sumber untuk Pengembangan](#-meluncurkan-aplikasi-dari-sumber-untuk-pengembangan)
|
||||
- 🔨 [Meluncurkan aplikasi dari Sumber untuk Pengembangan](#-menjalankan-aplikasi-dari-sumber-untuk-pengembangan)
|
||||
- 📚 [Dokumentasi](#-dokumentasi)
|
||||
- 📜 [Peta Jalan](#-peta-jalan)
|
||||
- 📜 [Peta Jalan](#-roadmap)
|
||||
- 🏄 [Komunitas](#-komunitas)
|
||||
- 🙌 [Kontribusi](#-kontribusi)
|
||||
|
||||
@@ -290,7 +290,7 @@ docker build --platform linux/amd64 \
|
||||
-f Dockerfile -t infiniflow/ragflow:nightly .
|
||||
```
|
||||
|
||||
## 🔨 Menjalankan Aplikasi dari untuk Pengembangan
|
||||
## 🔨 Menjalankan Aplikasi dari Sumber untuk Pengembangan
|
||||
|
||||
1. Instal `uv`, atau lewati langkah ini jika sudah terinstal:
|
||||
|
||||
|
||||
@@ -64,9 +64,8 @@
|
||||
- 🔎 [Arquitetura do Sistema](#-arquitetura-do-sistema)
|
||||
- 🎬 [Auto-hospedagem](#-auto-hospedagem)
|
||||
- 🔧 [Configurações](#-configurações)
|
||||
- 🔧 [Construir uma imagem docker sem incorporar modelos](#-construir-uma-imagem-docker-sem-incorporar-modelos)
|
||||
- 🔧 [Construir uma imagem docker incluindo modelos](#-construir-uma-imagem-docker-incluindo-modelos)
|
||||
- 🔨 [Lançar serviço a partir do código-fonte para desenvolvimento](#-lançar-serviço-a-partir-do-código-fonte-para-desenvolvimento)
|
||||
- 🔧 [Criar uma imagem Docker](#-criar-uma-imagem-docker)
|
||||
- 🔨 [Lançar serviço a partir do código-fonte para desenvolvimento](#-lançar-o-serviço-a-partir-do-código-fonte-para-desenvolvimento)
|
||||
- 📚 [Documentação](#-documentação)
|
||||
- 📜 [Roadmap](#-roadmap)
|
||||
- 🏄 [Comunidade](#-comunidade)
|
||||
|
||||
@@ -1737,13 +1737,13 @@ def execute_code(
|
||||
|
||||
**Provider implementations**:
|
||||
|
||||
1. **Self-managed provider** ([self_managed.py:164](agent/sandbox/providers/self_managed.py:164)):
|
||||
1. **Self-managed provider** ([self_managed.py:164](providers/self_managed.py)):
|
||||
- Passes arguments via HTTP API: `"arguments": arguments or {}`
|
||||
- executor_manager writes `args.json` into the per-task workspace
|
||||
- Runner script loads arguments from `args.json`
|
||||
- Python runner calls `main(**args)` and JavaScript runner calls `main(args)`
|
||||
|
||||
2. **Aliyun Code Interpreter** ([aliyun_codeinterpreter.py:260-275](agent/sandbox/providers/aliyun_codeinterpreter.py:260-275)):
|
||||
2. **Aliyun Code Interpreter** ([aliyun_codeinterpreter.py:260-275](providers/aliyun_codeinterpreter.py)):
|
||||
- Wraps user code to call `main(**arguments)` or `main()` if no arguments
|
||||
- Python example:
|
||||
```python
|
||||
@@ -1766,7 +1766,7 @@ def execute_code(
|
||||
'''
|
||||
```
|
||||
|
||||
**Client layer** ([client.py:138-190](agent/sandbox/client.py:138-190)):
|
||||
**Client layer** ([client.py:138-190](client.py)):
|
||||
```python
|
||||
def execute_code(
|
||||
code: str,
|
||||
@@ -1791,7 +1791,7 @@ def execute_code(
|
||||
provider.destroy_instance(instance.instance_id)
|
||||
```
|
||||
|
||||
**CodeExec tool integration** ([code_exec.py:136-165](agent/tools/code_exec.py:136-165)):
|
||||
**CodeExec tool integration** ([code_exec.py:136-165](../tools/code_exec.py)):
|
||||
```python
|
||||
def _execute_code(self, language: str, code: str, arguments: dict):
|
||||
# ... collect arguments from component configuration
|
||||
|
||||
@@ -248,7 +248,7 @@ rm agent/sandbox/tests/test_aliyun_integration.py
|
||||
## Related Documentation
|
||||
|
||||
- [Official Documentation](https://help.aliyun.com/zh/functioncompute/fc/sandbox-sandbox-code-interepreter)
|
||||
- [Sandbox Specification](../docs/develop/sandbox_spec.md)
|
||||
- [Sandbox Specification](../sandbox_spec.md)
|
||||
- [Testing Guide](./README.md)
|
||||
- [Quick Start](./QUICKSTART.md)
|
||||
|
||||
|
||||
@@ -174,5 +174,5 @@ pytest agent/sandbox/tests/test_aliyun_integration.py -v --timeout=60
|
||||
## Need Help?
|
||||
|
||||
- See the [full documentation](README.md)
|
||||
- Check the [sandbox specification](../../../../../docs/develop/sandbox_spec.md)
|
||||
- Check the [sandbox specification](../sandbox_spec.md)
|
||||
- Contact the RAGFlow team
|
||||
|
||||
@@ -183,7 +183,7 @@ Before setting `DOC_ENGINE=oceanbase`, make sure the host OS allows the file des
|
||||
|
||||
## 🐋 Service configuration
|
||||
|
||||
[service_conf.yaml](./service_conf.yaml) specifies the system-level configuration for RAGFlow and is used by its API server and task executor. In a dockerized setup, this file is automatically created based on the [service_conf.yaml.template](./service_conf.yaml.template) file (replacing all environment variables by their values).
|
||||
[service_conf.yaml.template](./service_conf.yaml.template) specifies the system-level configuration for RAGFlow and is used by its API server and task executor. In a dockerized setup, the generated `service_conf.yaml` file is automatically created from this template (replacing all environment variables by their values).
|
||||
|
||||
- `ragflow`
|
||||
- `host`: The API server's IP address inside the Docker container. Defaults to `0.0.0.0`.
|
||||
|
||||
@@ -186,7 +186,7 @@ s3:
|
||||
- `region_name`: Must be `auto`.
|
||||
- `endpoint_url`: `https://t3.storage.dev`, or `https://fly.storage.tigris.dev` on Fly.io.
|
||||
- `addressing_style`: Must be `virtual`.
|
||||
- `bucket` / `prefix_path`: Optional. Enables single-bucket mode — see [Migrate from multi-bucket to single-bucket mode](/migration#migrate-from-multi-bucket-to-single-bucket-mode).
|
||||
- `bucket` / `prefix_path`: Optional. Enables single-bucket mode — see [Migrate from multi-bucket to single-bucket mode](../migration/backup_and_migration.md#migrate-from-multi-bucket-to-single-bucket-mode).
|
||||
|
||||
When using an external storage backend, you can remove the `minio` service from `docker-compose-base.yml`.
|
||||
|
||||
|
||||
@@ -242,7 +242,7 @@ s3:
|
||||
addressing_style: "virtual"
|
||||
```
|
||||
|
||||
See [S3 (Tigris)](/configurations#s3-tigris) for full setup instructions.
|
||||
See [S3 (Tigris)](../configurations/configurations.md#s3-tigris) for full setup instructions.
|
||||
|
||||
### Iam Policy Example
|
||||
|
||||
|
||||
@@ -897,7 +897,7 @@ Automated metrics collection covers: tool success rate, approval latency, retry
|
||||
|
||||
A production trace can be automatically converted into a **regression dataset**. The `RunReplayEval` function replays each case with multiple model/strategy combinations, comparing results and raising regression alerts.
|
||||
|
||||
> **Detailed design, type definitions, and source-level examples** are documented in [harness.md](harness.md).
|
||||
> **Detailed design, type definitions, and source-level examples** are documented in [the Event Sourcing & Replay section](#event-sourcing--replay).
|
||||
|
||||
---
|
||||
|
||||
@@ -1118,8 +1118,6 @@ agent := agentcore.NewReActAgent(cfg)
|
||||
|
||||
### Full loop example
|
||||
|
||||
See [examples/workflow/loop/](examples/workflow/loop/).
|
||||
|
||||
```go
|
||||
wf, err := agentcore.NewLoop(ctx, &agentcore.LoopConfig{
|
||||
Name: "reflection_agent",
|
||||
@@ -1158,7 +1156,7 @@ func (m *LoggingMiddleware) AfterModelRewrite(
|
||||
|
||||
## Contributing
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
||||
See [docs/develop/contributing.md](../../docs/develop/contributing.md) for guidelines.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user