Skip to content

Commit

Permalink
docs: use absolute url in docs (#649)
Browse files Browse the repository at this point in the history
  • Loading branch information
huxuan authored Jul 8, 2024
1 parent 6f1f2cb commit c8f843b
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/development/commit.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ A "breaking change" refers to any modification that disrupts the existing functi
## Commit in Development Branches

While the commit convention seems strict, we aim for flexibility during the development phase.
By adhering to the <project:../management/settings.md>, all changes should be introduced via pull/merge requests.
By adhering to the <project:/management/settings.md>, all changes should be introduced via pull/merge requests.
Using the squash merge strategy, the emphasis is primarily on the title of pull/merge requests.
In this way, individual commit within development branches does not need to strictly adhere to the commit convention.

Expand Down
2 changes: 1 addition & 1 deletion docs/development/setup-dev-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ This command will accomplish the following tasks:
- Install the project in editable mode.
- Install git hook scripts for `pre-commit`.

To speed up the setup process in certain scenarios, you may find <project:../advanced/partial-dev-env.md> helpful.
To speed up the setup process in certain scenarios, you may find <project:/advanced/partial-dev-env.md> helpful.
2 changes: 1 addition & 1 deletion docs/management/release.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Release Process

With the integration of [semantic-release](https://github.com/semantic-release/semantic-release), the release process is fully automated. To enable this, follow the settings for <project:./settings.md#renovate-and-semantic-release>. Besides, adhering to the [Commit Convention](../development/commit.md#commit-message-pattern) is strongly recommended to ensure the release process works as expected.
With the integration of [semantic-release](https://github.com/semantic-release/semantic-release), the release process is fully automated. To enable this, follow the settings for <project:/management/settings.md#renovate-and-semantic-release>. Besides, adhering to the <project:/development/commit.md#commit-message-pattern> is strongly recommended to ensure the release process works as expected.

## Release Configuration

Expand Down
2 changes: 1 addition & 1 deletion template/docs/development/commit.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ A "breaking change" refers to any modification that disrupts the existing functi
## Commit in Development Branches

While the commit convention seems strict, we aim for flexibility during the development phase.
By adhering to the <project:../management/settings.md>, all changes should be introduced via pull/merge requests.
By adhering to the <project:/management/settings.md>, all changes should be introduced via pull/merge requests.
Using the squash merge strategy, the emphasis is primarily on the title of pull/merge requests.
In this way, individual commit within development branches does not need to strictly adhere to the commit convention.

Expand Down
2 changes: 1 addition & 1 deletion template/docs/development/setup-dev-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ This command will accomplish the following tasks:
- Install the project in editable mode.
- Install git hook scripts for `pre-commit`.

To speed up the setup process in certain scenarios, you may find <project:../advanced/partial-dev-env.md> helpful.
To speed up the setup process in certain scenarios, you may find <project:/advanced/partial-dev-env.md> helpful.
2 changes: 1 addition & 1 deletion template/docs/management/release.md.jinja
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Release Process

With the integration of [semantic-release](https://github.com/semantic-release/semantic-release), the release process is fully automated. To enable this, follow the settings for <project:./settings.md#renovate-and-semantic-release>. Besides, adhering to the [Commit Convention](../development/commit.md#commit-message-pattern) is strongly recommended to ensure the release process works as expected.
With the integration of [semantic-release](https://github.com/semantic-release/semantic-release), the release process is fully automated. To enable this, follow the settings for <project:/management/settings.md#renovate-and-semantic-release>. Besides, adhering to the <project:/development/commit.md#commit-message-pattern> is strongly recommended to ensure the release process works as expected.

## Release Configuration

Expand Down

0 comments on commit c8f843b

Please sign in to comment.