Skip to content

Commit 4b5145b

Browse files
authored
docs: update website (#11)
* chore: remove obsolete VibeSync configuration files and update changelog links * chore: update package references to @nicepkg/vsync and release version 1.0.9 * chore: update package.json with repository details, author information, and keywords * chore: update package.json description to clarify functionality of the CLI tool * chore: remove obsolete changeset for version 10 * feat: add isMainModule function to determine if the current module is the main entry point * fix: resolve CLI functionality issue * docs: add full documentation link to README files * chore: add changeset for release v1.0.9 with patch for @nicepkg/vsync * chore: update documentation links to absolute paths and remove obsolete changeset
1 parent de127cb commit 4b5145b

16 files changed

+110
-110
lines changed

website/content/en/_meta.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ export default {
2323
commands: {
2424
title: "Commands",
2525
type: "page",
26-
href: "./docs/cli-commands",
26+
href: "/en/docs/cli-commands",
2727
},
2828
[packageJson.version]: {
2929
title: `v${packageJson.version}`,
3030
type: "menu",
3131
items: {
3232
contributing: {
3333
title: "Contributing",
34-
href: "./contributing",
34+
href: "/en/contributing",
3535
},
3636
changelog: {
3737
title: "Changelog",

website/content/en/docs/advanced-features.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -447,6 +447,6 @@ cat .vsync.json
447447

448448
## Next Steps
449449

450-
- Check the [FAQ](../faq) for common questions
451-
- Read about [Contributing](../../contributing) to vsync
452-
- Explore [Configuration](../configuration) details
450+
- Check the [FAQ](/en/docs/faq) for common questions
451+
- Read about [Contributing](/en/contributing) to vsync
452+
- Explore [Configuration](/en/docs/configuration) details

website/content/en/docs/cli-commands.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -549,6 +549,6 @@ vsync sync --help
549549

550550
## Next Steps
551551

552-
- Learn about [Advanced Features](../advanced-features)
553-
- Check the [FAQ](../faq) for troubleshooting
554-
- Explore [Configuration](../configuration) options
552+
- Learn about [Advanced Features](/en/docs/advanced-features)
553+
- Check the [FAQ](/en/docs/faq) for troubleshooting
554+
- Explore [Configuration](/en/docs/configuration) options

website/content/en/docs/configuration.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,6 @@ Always use variable references, never hardcode:
325325

326326
## Next Steps
327327

328-
- Learn all [CLI Commands](../cli-commands)
329-
- Explore [Advanced Features](../advanced-features)
330-
- Check the [FAQ](../faq) for troubleshooting
328+
- Learn all [CLI Commands](/en/docs/cli-commands)
329+
- Explore [Advanced Features](/en/docs/advanced-features)
330+
- Check the [FAQ](/en/docs/faq) for troubleshooting

website/content/en/docs/core-concepts.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,6 @@ Quick command shortcuts.
247247

248248
Now that you understand the core concepts:
249249

250-
- Learn about [Configuration](../configuration) file structure
251-
- Explore [CLI Commands](../cli-commands) in detail
252-
- Discover [Advanced Features](../advanced-features) like symlinks
250+
- Learn about [Configuration](/en/docs/configuration) file structure
251+
- Explore [CLI Commands](/en/docs/cli-commands) in detail
252+
- Discover [Advanced Features](/en/docs/advanced-features) like symlinks

website/content/en/docs/getting-started.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ For global user-level configuration:
4747
vsync init --user
4848
```
4949

50-
> 💡 **Tip**: Learn more about [project vs user levels](../core-concepts#configuration-layers) in Core Concepts.
50+
> 💡 **Tip**: Learn more about [project vs user levels](/en/docs/core-concepts#configuration-layers) in Core Concepts.
5151
5252
### Interactive Setup
5353

@@ -79,7 +79,7 @@ The CLI will guide you through the setup process:
7979
✅ Setup complete! Run vsync sync to start syncing
8080
```
8181

82-
> 📚 **Learn more**: See [Configuration](../configuration) for detailed config options.
82+
> 📚 **Learn more**: See [Configuration](/en/docs/configuration) for detailed config options.
8383
8484
### 2. Sync Your Configs
8585

@@ -96,7 +96,7 @@ vsync sync --dry-run
9696
vsync sync --prune
9797
```
9898

99-
> 🔍 **Details**: Understand [sync modes](../core-concepts#sync-modes) in Core Concepts.
99+
> 🔍 **Details**: Understand [sync modes](/en/docs/core-concepts#sync-modes) in Core Concepts.
100100
101101
## Understanding the Output
102102

@@ -130,11 +130,11 @@ cursor:
130130

131131
Now that you've installed and initialized vsync:
132132

133-
1. **Learn the Concepts**: Understand [Core Concepts](../core-concepts) like sync modes and layers
134-
2. **Configure Tools**: Explore [Configuration](../configuration) options for each tool
135-
3. **Master Commands**: Check out all [CLI Commands](../cli-commands)
136-
4. **Quick Reference**: Use the [Quick Reference](../quick-reference) cheat sheet
137-
5. **Advanced Usage**: Dive into [Advanced Features](../advanced-features) like symlinks
133+
1. **Learn the Concepts**: Understand [Core Concepts](/en/docs/core-concepts) like sync modes and layers
134+
2. **Configure Tools**: Explore [Configuration](/en/docs/configuration) options for each tool
135+
3. **Master Commands**: Check out all [CLI Commands](/en/docs/cli-commands)
136+
4. **Quick Reference**: Use the [Quick Reference](/en/docs/quick-reference) cheat sheet
137+
5. **Advanced Usage**: Dive into [Advanced Features](/en/docs/advanced-features) like symlinks
138138

139139
## Real-World Examples
140140

@@ -157,7 +157,7 @@ vsync init --user # Configure which tools to sync
157157
vsync sync --user # Sync personal Skills, MCP servers globally
158158
```
159159

160-
> 💡 **Related**: Learn about [configuration layers](../core-concepts#configuration-layers).
160+
> 💡 **Related**: Learn about [configuration layers](/en/docs/core-concepts#configuration-layers).
161161
162162
### Migration Between Tools
163163

@@ -169,7 +169,7 @@ vsync init # Choose Cursor as SOURCE (reference standard)
169169
vsync sync # All configs migrated instantly!
170170
```
171171

172-
> 📖 **More info**: See [FAQ - Migration Questions](../faq#migration-questions).
172+
> 📖 **More info**: See [FAQ - Migration Questions](/en/docs/faq#migration-questions).
173173
174174
## Troubleshooting
175175

@@ -185,12 +185,12 @@ Make sure the tool's configuration directory exists (e.g., `.claude/`, `.cursor/
185185

186186
On macOS/Linux, you may need to grant permissions for file operations. Check that you have write access to the target directories.
187187

188-
> 🔧 **More help**: See the [FAQ](../faq#troubleshooting) for detailed troubleshooting.
188+
> 🔧 **More help**: See the [FAQ](/en/docs/faq#troubleshooting) for detailed troubleshooting.
189189
190190
## Getting Help
191191

192192
- Run `vsync --help` for command overview
193193
- Run `vsync <command> --help` for specific command help
194-
- Check the [FAQ](../faq) for common questions
195-
- Use the [Quick Reference](../quick-reference) for command examples
194+
- Check the [FAQ](/en/docs/faq) for common questions
195+
- Use the [Quick Reference](/en/docs/quick-reference) for command examples
196196
- Open an issue on [GitHub](https://github.com/nicepkg/vsync/issues)

website/content/en/docs/index.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@ Welcome to the vsync documentation! Here you'll find everything you need to sync
2121

2222
### Getting Started
2323

24-
- **[Getting Started](../getting-started)** - Installation, initialization, and first sync
25-
- **[Core Concepts](../core-concepts)** - Understanding sync modes, layers, and workflows
24+
- **[Getting Started](/en/docs/getting-started)** - Installation, initialization, and first sync
25+
- **[Core Concepts](/en/docs/core-concepts)** - Understanding sync modes, layers, and workflows
2626

2727
### Reference
2828

29-
- **[Configuration](../configuration)** - Config file structure and tool-specific formats
30-
- **[CLI Commands](../cli-commands)** - Complete command reference with examples
31-
- **[Quick Reference](../quick-reference)** - Command cheat sheet and common patterns
29+
- **[Configuration](/en/docs/configuration)** - Config file structure and tool-specific formats
30+
- **[CLI Commands](/en/docs/cli-commands)** - Complete command reference with examples
31+
- **[Quick Reference](/en/docs/quick-reference)** - Command cheat sheet and common patterns
3232

3333
### Advanced
3434

35-
- **[Advanced Features](../advanced-features)** - Symlinks, performance optimization, and more
36-
- **[FAQ](../faq)** - Common questions and troubleshooting
35+
- **[Advanced Features](/en/docs/advanced-features)** - Symlinks, performance optimization, and more
36+
- **[FAQ](/en/docs/faq)** - Common questions and troubleshooting
3737

3838
## Supported AI Tools
3939

@@ -91,6 +91,6 @@ vsync sync
9191

9292
- **GitHub Issues**: [Report bugs or request features](https://github.com/nicepkg/vsync/issues)
9393
- **CLI Help**: Run `vsync --help` or `vsync <command> --help`
94-
- **Contributing**: Check out the [Contributing Guide](../../contributing)
94+
- **Contributing**: Check out the [Contributing Guide](/en/contributing)
9595

96-
Ready to get started? Head over to [Getting Started](../getting-started)!
96+
Ready to get started? Head over to [Getting Started](/en/docs/getting-started)!

website/content/en/docs/quick-reference.mdx

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ vsync init --user
3333
vsync sync --user
3434
```
3535

36-
**[Learn more →](../getting-started)**
36+
**[Learn more →](/en/docs/getting-started)**
3737

3838
### Daily Sync
3939

@@ -68,7 +68,7 @@ vsync clean skill/old-skill
6868
vsync sync --prune
6969
```
7070

71-
**[Learn more →](../cli-commands#clean)**
71+
**[Learn more →](/en/docs/cli-commands#clean)**
7272

7373
## Sync Modes
7474

@@ -82,7 +82,7 @@ vsync sync
8282
- ✅ Updates existing items
8383
- ❌ Never deletes
8484

85-
**[Learn more →](../core-concepts#safe-mode-default)**
85+
**[Learn more →](/en/docs/core-concepts#safe-mode-default)**
8686

8787
### Prune Mode
8888

@@ -94,7 +94,7 @@ vsync sync --prune
9494
- ✅ Updates existing items
9595
- ⚠️ Deletes items not in source
9696

97-
**[Learn more →](../core-concepts#prune-mode)**
97+
**[Learn more →](/en/docs/core-concepts#prune-mode)**
9898

9999
## Configuration Layers
100100

@@ -118,7 +118,7 @@ vsync sync --user # Syncs global configs
118118

119119
**Use for**: Personal preferences, global skills
120120

121-
**[Learn more →](../core-concepts#configuration-layers)**
121+
**[Learn more →](/en/docs/core-concepts#configuration-layers)**
122122

123123
## Command Examples
124124

@@ -206,7 +206,7 @@ vsync clean --user
206206
vsync clean skill/old-skill -y
207207
```
208208

209-
**[Learn more →](../cli-commands#clean)**
209+
**[Learn more →](/en/docs/cli-commands#clean)**
210210

211211
### import
212212

@@ -237,7 +237,7 @@ vsync import ../other-project --user
237237
}
238238
```
239239

240-
**[Learn more →](../configuration)**
240+
**[Learn more →](/en/docs/configuration)**
241241

242242
### Key Settings
243243

@@ -261,7 +261,7 @@ vsync import ../other-project --user
261261
| OpenCode | `{env:VAR}` | `{env:API_KEY}` |
262262
| Codex | No interpolation | Direct value |
263263

264-
**[Learn more →](../configuration#mcp-configuration-differences)**
264+
**[Learn more →](/en/docs/configuration#mcp-configuration-differences)**
265265

266266
### Config File Locations
267267

@@ -272,7 +272,7 @@ vsync import ../other-project --user
272272
| OpenCode | `opencode.json(c)` | `~/.opencode/opencode.json` |
273273
| Codex | `config.toml` | `~/.codex/config.toml` |
274274

275-
**[Learn more →](../configuration#supported-tools)**
275+
**[Learn more →](/en/docs/configuration#supported-tools)**
276276

277277
## Common Patterns
278278

@@ -297,7 +297,7 @@ vsync sync
297297
run: npx @nicepkg/vsync sync --yes
298298
```
299299

300-
**[Learn more →](../advanced-features#cicd-integration)**
300+
**[Learn more →](/en/docs/advanced-features#cicd-integration)**
301301

302302
### Migration Workflow
303303

@@ -312,7 +312,7 @@ vsync plan
312312
vsync sync
313313
```
314314

315-
**[Learn more →](../faq#migration-questions)**
315+
**[Learn more →](/en/docs/faq#migration-questions)**
316316

317317
## Exit Codes
318318

@@ -360,14 +360,14 @@ mkdir -p ~/.cursor
360360
vsync init
361361
```
362362

363-
**[More troubleshooting →](../faq#troubleshooting)**
363+
**[More troubleshooting →](/en/docs/faq#troubleshooting)**
364364

365365
## Related Resources
366366

367-
- **[Getting Started](../getting-started)** - Detailed installation guide
368-
- **[Core Concepts](../core-concepts)** - Understanding vsync
369-
- **[CLI Commands](../cli-commands)** - Full command reference
370-
- **[Configuration](../configuration)** - Config file details
371-
- **[Advanced Features](../advanced-features)** - Symlinks, performance
372-
- **[FAQ](../faq)** - Common questions
373-
- **[Contributing](../../contributing)** - Development guide
367+
- **[Getting Started](/en/docs/getting-started)** - Detailed installation guide
368+
- **[Core Concepts](/en/docs/core-concepts)** - Understanding vsync
369+
- **[CLI Commands](/en/docs/cli-commands)** - Full command reference
370+
- **[Configuration](/en/docs/configuration)** - Config file details
371+
- **[Advanced Features](/en/docs/advanced-features)** - Symlinks, performance
372+
- **[FAQ](/en/docs/faq)** - Common questions
373+
- **[Contributing](/en/contributing)** - Development guide

website/content/zh/_meta.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ export default {
2323
commands: {
2424
title: "CLI 命令",
2525
type: "page",
26-
href: "./docs/cli-commands",
26+
href: "/zh/docs/cli-commands",
2727
},
2828
[packageJson.version]: {
2929
title: `v${packageJson.version}`,
3030
type: "menu",
3131
items: {
3232
contributing: {
3333
title: "贡献指南",
34-
href: "./contributing",
34+
href: "/zh/contributing",
3535
},
3636
changelog: {
3737
title: "更新日志",

website/content/zh/docs/advanced-features.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -447,6 +447,6 @@ cat .vsync.json
447447

448448
## 下一步
449449

450-
- 查看 [FAQ](../faq) 了解常见问题
451-
- 阅读关于[贡献](../../contributing)到 vsync
452-
- 探索[配置](../configuration)详情
450+
- 查看 [FAQ](/zh/docs/faq) 了解常见问题
451+
- 阅读关于[贡献](/zh/contributing)到 vsync
452+
- 探索[配置](/zh/docs/configuration)详情

0 commit comments

Comments
 (0)