Skip to content

Commit

Permalink
doc: Update get_started link
Browse files Browse the repository at this point in the history
  • Loading branch information
sun-xiangyu committed Apr 28, 2024
1 parent 97e1c52 commit 4201686
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 5 deletions.
27 changes: 25 additions & 2 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,37 @@ stages:

variables:
# Versioned esp-idf-doc env image to use for all document building jobs
ESP_DOCS_ENV_IMAGE: "$CI_DOCKER_REGISTRY/esp-idf-doc-env-v5.0:2-2"
ESP_DOCS_ENV_IMAGE: "$CI_DOCKER_REGISTRY/esp-idf-doc-env-v5.0"
ESP_DOCS_PATH: "$CI_PROJECT_DIR"

.if-protected: &if-protected
if: '($CI_COMMIT_REF_NAME == "master" || $CI_COMMIT_BRANCH =~ /^release\/v/ || $CI_COMMIT_TAG =~ /^v\d+\.\d+(\.\d+)?($|-)/)'

.if-dev-push: &if-dev-push
if: '$CI_COMMIT_REF_NAME != "master" && $CI_COMMIT_BRANCH !~ /^release\/v/ && $CI_COMMIT_TAG !~ /^v\d+\.\d+(\.\d+)?($|-)/ && ($CI_PIPELINE_SOURCE == "push" || $CI_PIPELINE_SOURCE == "merge_request_event")'

.if-label-build: &if-label-build
if: '$CI_MERGE_REQUEST_LABELS =~ /^(?:[^,\n\r]+,)*build(?:,[^,\n\r]+)*$/i'


.patterns-build_docs: &patterns-build_docs
- "docs/**/*"

.rules:build_docs:docs:
rules:
- <<: *if-protected
- <<: *if-label-build
- <<: *if-dev-push
changes: *patterns-build_docs

.build_template:
stage: build
image: $ESP_DOCS_ENV_IMAGE

build_esp_dl_html:
extends:
- .build_template
- .rules:build_docs:docs
variables:
DOCS_DIR: $CI_PROJECT_DIR/docs
artifacts:
Expand All @@ -36,6 +57,7 @@ build_esp_dl_html:
build_esp_dl_pdf:
extends:
- .build_template
- .rules:build_docs:docs
variables:
DOCS_DIR: $CI_PROJECT_DIR/docs
artifacts:
Expand Down Expand Up @@ -72,6 +94,7 @@ build_esp_dl_pdf:
deploy_docs_preview:
extends:
- .deploy_docs_template
- .rules:build_docs:docs
variables:
TYPE: "preview"
DOCS_BUILD_DIR: "${CI_PROJECT_DIR}/docs/_build/"
Expand All @@ -95,4 +118,4 @@ deploy_docs_production:
DOCS_DEPLOY_SERVER: "$DOCS_PROD_SERVER"
DOCS_DEPLOY_SERVER_USER: "$DOCS_PROD_SERVER_USER"
DOCS_DEPLOY_PATH: "$DOCS_PROD_PATH"
DOCS_DEPLOY_URL_BASE: "https://docs.espressif.com/projects/esp-dl"
DOCS_DEPLOY_URL_BASE: "https://docs.espressif.com/projects/esp-dl"
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ As ESP-DL does not need any peripherals, it can be used as a component of some p

## Get Started with ESP-DL

For setup instructions to get started with ESP-DL, please read [Get Started](./docs/en/get_started.md).
For setup instructions to get started with ESP-DL, please read [Get Started](https://docs.espressif.com/projects/esp-dl/en/latest/esp32s3/get-started.html).

> Please use [ESP-IDF](https://github.com/espressif/esp-idf) `release/v5.0` or above.
Expand Down
4 changes: 2 additions & 2 deletions README_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ ESP-DL 无需借助任何外围设备,因此可作为一些项目的组件,

## 入门指南

安装并入门 ESP-DL,请参考[快速入门](./docs/en/get_started.md)
安装并入门 ESP-DL,请参考[快速入门](https://docs.espressif.com/projects/esp-dl/en/latest/esp32s3/get-started.html)
> 请使用 ESP-IDF 5.0 或以上版本[最新版本](https://github.com/espressif/esp-idf/tree/release/v5.0)

Expand All @@ -43,4 +43,4 @@ ESP-DL 在 [模型库](./include/model_zoo) 中提供了一些模型的 API,

## 反馈

如果您在使用中发现了错误或者需要新的功能,请提交相关 [issue](https://github.com/espressif/esp-dl/issues),我们会优先实现最受期待的功能。
如果您在使用中发现了错误或者需要新的功能,请提交相关 [issue](https://github.com/espressif/esp-dl/issues),我们会优先实现最受期待的功能。

0 comments on commit 4201686

Please sign in to comment.