Skip to content

Commit 739fece

Browse files
authored
Merge pull request #316 from deploystackio/main
prod release
2 parents d955257 + fe2cc4d commit 739fece

29 files changed

+249
-119
lines changed

.github/workflows/ci.yml

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,11 @@ on:
99
- main
1010

1111
permissions:
12-
contents: write
13-
issues: write
14-
pull-requests: write
12+
contents: read
1513

1614
jobs:
17-
lint_build:
18-
name: Run ESLint
15+
lint_and_validate:
16+
name: Lint and Validate Documentation
1917
runs-on: ubuntu-latest
2018

2119
steps:
@@ -30,28 +28,8 @@ jobs:
3028
- name: Install Dependencies
3129
run: npm ci
3230

33-
- name: Run Markdown ESLint
31+
- name: Run Markdown Linting
3432
run: npm run lint:md
3533

36-
- name: Run Lint Links
37-
run: npm run lint:links
38-
39-
release:
40-
name: Run Release
41-
runs-on: ubuntu-latest
42-
needs: lint_build
43-
44-
steps:
45-
- name: Checkout Code
46-
uses: actions/checkout@v4
47-
48-
- name: Setup Node.js
49-
uses: actions/setup-node@v4
50-
with:
51-
node-version: 20
52-
- run: npm ci
53-
- run: npm audit signatures
54-
- name: Release
55-
env:
56-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
57-
run: npm run semantic-release
34+
- name: Validate Links
35+
run: npm run lint:links

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ mintlify dev
6161
```
6262

6363
The local server provides:
64+
6465
- Hot reloading for instant content updates
6566
- Navigation preview
6667
- Component rendering
@@ -96,6 +97,7 @@ More content here...
9697
Mintlify provides built-in components for enhanced documentation:
9798

9899
**Callouts:**
100+
99101
```mdx
100102
<Note>General information</Note>
101103
<Info>Important information</Info>
@@ -106,6 +108,7 @@ Mintlify provides built-in components for enhanced documentation:
106108
```
107109

108110
**Code Groups:**
111+
109112
```mdx
110113
<CodeGroup>
111114
`\`\`bash macOS/Linux
@@ -118,8 +121,8 @@ npm install
118121
</CodeGroup>
119122
```
120123

121-
122124
**Cards:**
125+
123126
```mdx
124127
<CardGroup cols={2}>
125128
<Card title="Getting Started" icon="rocket" href="/general/quick-start">
@@ -132,6 +135,7 @@ npm install
132135
```
133136

134137
**Steps:**
138+
135139
```mdx
136140
<Steps>
137141
<Step title="Install Dependencies">
@@ -155,26 +159,31 @@ Navigation is controlled via `docs.json`:
155159
- **Pages**: Individual documentation pages
156160

157161
To add a new page:
162+
158163
1. Create the `.mdx` file in the appropriate directory
159164
2. Add the page path to `docs.json` under the relevant group
160165
3. Test locally with `mintlify dev`
161166

162167
### Content Guidelines
163168

164169
**File Naming:**
170+
165171
- Use kebab-case: `my-new-page.mdx`
166172
- Index files represent the directory: `index.mdx`
167173

168174
**Links:**
175+
169176
- Use absolute paths from documentation root: `/development/backend/api/index`
170177
- Mintlify automatically handles `.mdx` extensions
171178

172179
**Images:**
180+
173181
- Store in `assets/images/` with logical subdirectories
174182
- Reference with absolute paths: `/assets/images/logo/dark.webp`
175183
- Optimize images before committing (compress file sizes)
176184

177185
**Frontmatter:**
186+
178187
```yaml
179188
---
180189
title: Page Title (required)
@@ -214,19 +223,22 @@ description: Page description for SEO (required)
214223
### Documentation Standards
215224

216225
**Writing Style:**
226+
217227
- Write in clear, concise language
218228
- Use active voice
219229
- Address the reader directly ("you")
220230
- Avoid jargon without explanation
221231
- Include code examples where helpful
222232

223233
**Code Examples:**
234+
224235
- Include complete, working examples
225236
- Add comments for clarity
226237
- Show expected output when relevant
227238
- Test all code before committing
228239

229240
**Structure:**
241+
230242
- Start with overview/introduction
231243
- Progress from basic to advanced
232244
- Use descriptive section headers

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);

context7.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"url": "https://context7.com/deploystackio/documentation",
3+
"public_key": "pk_ElwBaquFd3aorFHMpJAin"
4+
}

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

0 commit comments

Comments
 (0)