Skip to content

docs: use ~/.vfox as the user directory in uninstall and config guides #714

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
aooohan merged 1 commit into from
Oct 2, 2026
+16 −8
Merged

docs: use ~/.vfox as the user directory in uninstall and config guides #714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions docs/guides/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Configuration

`vfox` allows you to change some configurations, all configuration is stored in the `$HOME/.version-fox/config.yaml`
`vfox` allows you to change some configurations, all configuration is stored in the `$HOME/.vfox/config.yaml`
file.

::: tip
Expand Down Expand Up @@ -58,7 +58,7 @@ proxy:

## Storage Settings

By default, `vfox` stores SDK cache files in the `$HOME/.version-fox/cache` directory.
By default, `vfox` stores SDK cache files in the `$HOME/.vfox/cache` directory.

::: danger !!!
Before configuring, please make sure that `vfox` has write permission to the folder.⚠⚠⚠
Expand Down Expand Up @@ -113,7 +113,7 @@ cache:
```

::: tip Cache File Path
`$HOME/.version-fox/plugins/<plugin-name>/available.cache`
`$HOME/.vfox/plugin/<plugin-name>/.available.cache`
:::

## Gitignore Settings <Badge type="tip" text=">= 1.0.12" vertical="middle" />
Expand Down
6 changes: 5 additions & 1 deletion docs/guides/uninstallation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,9 +207,13 @@ This will permanently delete all SDK versions you installed through vfox!
### Remove vfox Data Directory

```shell
rm -rf ~/.version-fox
rm -rf ~/.vfox
```

::: tip
vfox versions before 1.0.0 used `~/.version-fox` instead. If that directory still exists, vfox keeps using it, so remove it as well.
:::

This directory contains:
- Installed SDK versions
- Plugin files
Expand Down
6 changes: 3 additions & 3 deletions docs/zh-hans/guides/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 配置

`vfox` 允许你修改一些配置, 所有配置信息都存放在`$HOME/.version-fox/config.yaml`文件中。
`vfox` 允许你修改一些配置, 所有配置信息都存放在`$HOME/.vfox/config.yaml`文件中。

::: tip 注意
如果你是首次运行`vfox`, 则会自动创建一个空的 config.yaml 文件。
Expand Down Expand Up @@ -55,7 +55,7 @@ proxy:

## 存储路径

`vfox`默认将 SDK 缓存文件存储在`$HOME/.version-fox/cache`目录下。
`vfox`默认将 SDK 缓存文件存储在`$HOME/.vfox/cache`目录下。

::: danger !!!
在配置之前， 请确保`vfox`有文件夹的写权限。⚠⚠⚠
Expand Down Expand Up @@ -110,7 +110,7 @@ cache:
```

::: tip 缓存文件路径
`$HOME/.version-fox/plugins/<plugin-name>/available.cache`
`$HOME/.vfox/plugin/<plugin-name>/.available.cache`
:::

## Gitignore 设置 <Badge type="tip" text=">= 1.0.12" vertical="middle" />
Expand Down
6 changes: 5 additions & 1 deletion docs/zh-hans/guides/uninstallation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,9 +207,13 @@ sudo rm /usr/local/bin/vfox
### 删除 vfox 数据目录

```shell
rm -rf ~/.version-fox
rm -rf ~/.vfox
```

::: tip 提示
vfox 1.0.0 之前使用的目录是 `~/.version-fox`。如果该目录仍然存在，vfox 会继续使用它，请一并删除。
:::

此目录包含：
- 已安装的 SDK 版本
- 插件文件
Expand Down
Loading