feat: add ignore dead links configuration and update documentation links #10
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request adds ignore dead links configuration to the VitePress documentation and updates various documentation links to point to more specific pages. The changes ensure better navigation within the documentation by directing users to introductory pages rather than index pages.
- Added
ignoreDeadLinksconfiguration to prevent build failures from localhost and placeholder URLs - Updated documentation links to point to specific introduction/landing pages instead of directory indexes
- Added terser dependency and reorganized package.json devDependencies alphabetically
Reviewed Changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| apps/docs/package.json | Added terser dependency and reorganized devDependencies alphabetically |
| apps/docs/index.md | Updated main documentation links to point to specific pages |
| apps/docs/guide/quick-start.md | Updated API documentation references to point to auth page |
| apps/docs/guide/introduction.md | Removed reference to non-existent features page |
| apps/docs/.vitepress/config.ts | Added ignoreDeadLinks configuration for localhost and placeholder URLs |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| // Ignore dead links configuration | ||
| ignoreDeadLinks: [ | ||
| /^http:\/\/localhost/, | ||
| /^http:\/\/YOUR_IP/ |
There was a problem hiding this comment.
The regex pattern /^http:\/\/YOUR_IP/ uses a placeholder 'YOUR_IP' which may not match actual IP addresses. Consider using a more specific pattern like /^http:\/\/\d+\.\d+\.\d+\.\d+/ for IPv4 addresses or document that 'YOUR_IP' should be replaced with actual values.
| /^http:\/\/YOUR_IP/ | |
| /^http:\/\/\d+\.\d+\.\d+\.\d+/ |
|
* feat: add ignore dead links configuration and update documentation links (TinyActive#10) * feat: set base path for nginx-love documentation * feat: add GitHub Actions workflow to check documentation build (TinyActive#11) * feat: add GitHub Actions workflow to check documentation build * rm path * doc update * doc update * update doc * user doc * doc update * up to date * up to date * up to date * up to date * docker not support * Remove Demo credentials text * Remove Demo credentials text * Producthunt link * feat: Update Logo Project --------- Co-authored-by: SangND <dacsang97@gmail.com>
2 participants
No description provided.