Skip to content

docs: use absolute url in docs #649

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 8, 2024
Merged

docs: use absolute url in docs #649

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7fa389
docs: use absolute url in docs
huxuan Jul 8, 2024
d28c397
minor consistency fix
huxuan Jul 8, 2024
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
2 changes: 1 addition & 1 deletion docs/development/commit.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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