Skip to content

Commit 52f792c

Browse files
author
Lasim
committed
fix: update documentation links to use the new general path structure
1 parent 675f69a commit 52f792c

25 files changed

+225
-89
lines changed

check-links.js

Lines changed: 46 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
1010
const IGNORED_URLS = [
1111
'https://deploystack.io',
1212
'https://deploystack.io/*',
13-
'https://cloud.deploystack.io'
13+
'https://cloud.deploystack.io',
14+
'https://docs.deploystack.io',
15+
'https://mintlify.com',
16+
'https://mintlify.com/*',
17+
'https://discord.gg/',
18+
'https://discord.gg/*'
1419
];
1520

1621
// Check if a URL should be ignored
@@ -55,19 +60,19 @@ const checkLocalFile = (linkPath, filePath) => {
5560
if (linkPath.startsWith('/') && !linkPath.startsWith('//') && !linkPath.startsWith('http')) {
5661
// Remove hash fragment before checking file existence
5762
const [baseUrl] = linkPath.split('#');
58-
63+
5964
// Map the URL to the actual file location
60-
// Since our URLs are now root-level but files are in docs/
61-
const actualFilePath = path.join(process.cwd(), 'docs', baseUrl.substring(1));
62-
65+
// Files are in the root directory structure
66+
const actualFilePath = path.join(process.cwd(), baseUrl.substring(1));
67+
6368
// Try both .mdx and .md extensions
6469
const possiblePaths = [
6570
actualFilePath + '.mdx',
6671
actualFilePath + '.md',
6772
path.join(actualFilePath, 'index.mdx'),
6873
path.join(actualFilePath, 'index.md')
6974
];
70-
75+
7176
for (const possiblePath of possiblePaths) {
7277
try {
7378
fs.accessSync(possiblePath, fs.constants.F_OK);
@@ -77,7 +82,7 @@ const checkLocalFile = (linkPath, filePath) => {
7782
// Continue to next possible path
7883
}
7984
}
80-
85+
8186
console.log(` ❌ ${linkPath} → File not found (checked: ${possiblePaths.map(p => path.relative(process.cwd(), p)).join(', ')})`);
8287
return false;
8388
}
@@ -189,9 +194,41 @@ const processDirectory = async (dir) => {
189194
return allValid;
190195
};
191196

192-
// Start processing
197+
// Directories to skip during scanning
198+
const SKIP_DIRS = ['node_modules', '.git', '.next', 'out', '.github', '.source'];
199+
200+
// Modified processDirectory to skip certain directories
201+
const shouldSkipDirectory = (dirName) => {
202+
return SKIP_DIRS.includes(dirName);
203+
};
204+
205+
// Start processing from current directory
193206
console.log('📝 Checking markdown links...\n');
194-
processDirectory('docs').then(allValid => {
207+
208+
const scanDirectory = async (dir) => {
209+
let allValid = true;
210+
const files = fs.readdirSync(dir);
211+
212+
for (const file of files) {
213+
const filePath = path.join(dir, file);
214+
const stat = fs.statSync(filePath);
215+
216+
if (stat.isDirectory()) {
217+
// Skip certain directories
218+
if (!shouldSkipDirectory(file)) {
219+
const isValid = await processDirectory(filePath);
220+
if (!isValid) allValid = false;
221+
}
222+
} else if (file.endsWith('.md') || file.endsWith('.mdx')) {
223+
const isValid = await processFile(filePath);
224+
if (!isValid) allValid = false;
225+
}
226+
}
227+
228+
return allValid;
229+
};
230+
231+
scanDirectory(process.cwd()).then(allValid => {
195232
if (!allValid) {
196233
console.log('❌ Some links are invalid!');
197234
process.exit(1);

development/backend/auth.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Technical documentation for the DeployStack backend authentication
44
---
55

66

7-
This document provides technical details about the DeployStack backend authentication system implementation. For user-facing authentication configuration, see [Authentication Methods](/auth). For OAuth provider implementation details, see [OAuth Provider Implementation](/development/backend/oauth-providers) and [OAuth2 Server Implementation](/development/backend/oauth2-server).
7+
This document provides technical details about the DeployStack backend authentication system implementation. For user-facing authentication configuration, see [Authentication Methods](/general/auth). For OAuth provider implementation details, see [OAuth Provider Implementation](/development/backend/oauth-providers) and [OAuth2 Server Implementation](/development/backend/oauth2-server).
88

99
## Architecture Overview
1010

development/backend/mcp-configuration-architecture.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -416,9 +416,9 @@ For specific implementation details:
416416
- [Backend API](/development/backend/api/) - Complete API endpoint documentation
417417
- [Database Schema](/development/backend/database/) - Database structure and relationships
418418
- [Job Queue System](/development/backend/job-queue) - Background job processing for registry sync
419-
- [Teams](/teams) - Team management and structure
420-
- [MCP Configuration System](/mcp-configuration) - User-facing configuration guide
421-
- [MCP Installation](/mcp-installation) - Installation and team setup
422-
- [MCP Catalog](/mcp-catalog) - Official registry integration details
419+
- [Teams](/general/teams) - Team management and structure
420+
- [MCP Configuration System](/general/mcp-configuration) - User-facing configuration guide
421+
- [MCP Installation](/general/mcp-installation) - Installation and team setup
422+
- [MCP Catalog](/general/mcp-catalog) - Official registry integration details
423423

424424
The three-tier configuration architecture provides a robust foundation for managing complex MCP server configurations in multi-user team environments while maintaining security, flexibility, and ease of use. The system seamlessly handles both manually created custom servers and automatically synced official registry servers.

development/backend/oauth-providers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,4 +282,4 @@ Frontend checks provider status to show login buttons:
282282
- [OAuth2 Server Implementation](/development/backend/oauth2-server) - OAuth2 server for API access
283283
- [Security Policy](/development/backend/security) - Security implementation details
284284
- [Global Settings](/development/backend/global-settings) - Configuration management
285-
- [GitHub OAuth Setup](/github-oauth-setup) - User-facing GitHub OAuth setup guide
285+
- [GitHub OAuth Setup](/general/github-oauth-setup) - User-facing GitHub OAuth setup guide

development/frontend/architecture.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -580,7 +580,7 @@ export function createColumns(): ColumnDef[] {
580580

581581
### Table Components
582582

583-
For table implementations, use the shadcn-vue Table components as documented in the [Table Design System](/development/frontend/ui/-table). Never use raw HTML table elements.
583+
For table implementations, use the shadcn-vue Table components as documented in the [Table Design System](/development/frontend/ui/design-system-table). Never use raw HTML table elements.
584584

585585
## Component Communication Patterns
586586

development/frontend/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,15 @@ The frontend follows a feature-based modular architecture with clear separation
6767

6868
For comprehensive component development guidelines, including Vue SFC best practices, component structure patterns, and implementation standards, see the [Frontend Architecture - Component Implementation Standards](/development/frontend/architecture#component-implementation-standards) section.
6969

70-
For table-specific implementations, refer to the [Table Design System](/development/frontend/ui/-table) guide.
70+
For table-specific implementations, refer to the [Table Design System](/development/frontend/ui/design-system-table) guide.
7171

7272
## UI Components and Styling
7373

7474
The frontend uses **TailwindCSS** for styling with **shadcn-vue** component library for consistent UI elements. For comprehensive styling guidelines, component patterns, and design standards, see the [UI Design System](/development/frontend/ui/) documentation.
7575

7676
### ⚠️ **Mandatory Design Patterns**
7777

78-
All structured information displays must follow the **[Structured Data Display Pattern](/development/frontend/ui/-structured-data)**. This includes:
78+
All structured information displays must follow the **[Structured Data Display Pattern](/development/frontend/ui/design-system-structured-data)**. This includes:
7979
- User profiles and settings
8080
- Form layouts
8181
- Configuration displays
@@ -125,7 +125,7 @@ Continue reading the detailed guides:
125125

126126
- [Frontend Architecture](/development/frontend/architecture) - Application architecture, patterns, and development principles
127127
- [UI Design System](/development/frontend/ui/) - Component patterns, styling guidelines, and design standards
128-
- **[Structured Data Display Pattern](/development/frontend/ui/-structured-data)** - **Mandatory pattern** for consistent information display
128+
- **[Structured Data Display Pattern](/development/frontend/ui/design-system-structured-data)** - **Mandatory pattern** for consistent information display
129129
- [Environment Variables](/development/frontend/environment-variables) - Complete environment configuration guide
130130
- [Global Event Bus](/development/frontend/event-bus) - Cross-component communication system
131131
- [Internationalization (i18n)](/development/frontend/internationalization) - Multi-language support

development/frontend/ui/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,9 +167,9 @@ This hierarchy is a **design system requirement** and must be followed consisten
167167

168168
## Data Tables
169169

170-
For data table implementation, see the dedicated [Table Design System](/development/frontend/ui/-table) guide.
170+
For data table implementation, see the dedicated [Table Design System](/development/frontend/ui/design-system-table) guide.
171171

172-
For pagination implementation, see the [Pagination Implementation Guide](/development/frontend/ui/-pagination).
172+
For pagination implementation, see the [Pagination Implementation Guide](/development/frontend/ui/design-system-pagination).
173173

174174
## Badge Design Patterns
175175

development/satellite/backend-communication.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ See `services/backend/src/db/schema.ts` for complete schema definitions.
293293
4. Backend consumes single-use token and issues permanent API key
294294
5. Satellite stores API key securely for ongoing communication
295295

296-
For detailed token validation process, see [Registration Security](/development/backend/satellite-communication#satellite-pairing-process).
296+
For detailed token validation process, see [Registration Security](/development/backend/satellite/communication#satellite-pairing-process).
297297

298298
**Ongoing Operations:**
299299
1. All requests include `Authorization: Bearer {api_key}`

development/satellite/mcp-server-token-injection.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ private isCacheValid(cachedAt: number, expiresAt: string | null): boolean {
227227

228228
### Tool Execution Injection
229229

230-
**File**: [services/satellite/src/core/mcp-server-wrapper.ts](https://github.com/deploystackio/deploystack/blob/main/services/satellite/src/core/mcp-server-wrapper.ts:711-760)
230+
**File**: [services/satellite/src/core/mcp-server-wrapper.ts](https://github.com/deploystackio/deploystack/blob/main/services/satellite/src/core/mcp-server-wrapper.ts)
231231

232232
**Purpose**: Injects OAuth tokens when executing tools on HTTP/SSE MCP servers.
233233

@@ -438,7 +438,7 @@ async handleHttpToolCall(serverName: string, originalToolName: string, args: unk
438438

439439
### Tool Discovery Injection
440440

441-
**File**: [services/satellite/src/services/remote-tool-discovery-manager.ts](https://github.com/deploystackio/deploystack/blob/main/services/satellite/src/services/remote-tool-discovery-manager.ts:376-440)
441+
**File**: [services/satellite/src/services/remote-tool-discovery-manager.ts](https://github.com/deploystackio/deploystack/blob/main/services/satellite/src/services/remote-tool-discovery-manager.ts)
442442

443443
**Purpose**: Injects OAuth tokens when discovering available tools from HTTP/SSE MCP servers.
444444

development/satellite/registration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ Satellites require registration tokens generated by administrators:
187187
- Scope: Can register team satellites for specific team only
188188
- Expiration: 24 hours (configurable)
189189

190-
For token generation APIs, see [Satellite Communication - Registration Tokens](/development/backend/satellite-communication#satellite-pairing-process).
190+
For token generation APIs, see [Satellite Communication - Registration Tokens](/development/backend/satellite/communication#satellite-pairing-process).
191191

192192
### Security Model
193193

0 commit comments

Comments
 (0)