Skip to content

Commit 20bd3df

Browse files
author
Lasim
committed
docs: update links in GitHub OAuth and Quick Start documentation for consistency and clarity
1 parent 4565ae1 commit 20bd3df

20 files changed

Lines changed: 36 additions & 34 deletions

docs/development/backend/api-security.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ fastify.get('/dual-auth-endpoint', {
179179
});
180180
```
181181

182-
For detailed OAuth2 implementation, see the [OAuth Implementation Guide](./oauth.mdx) and [Security Policy](./security.mdx#oauth2-server-security).
182+
For detailed OAuth2 implementation, see the [Backend OAuth Implementation Guide](/development/backend/oauth) and [Backend Security Policy](/development/backend/security#oauth2-server-security).
183183

184184
### Team-Aware Permission System
185185

@@ -485,5 +485,5 @@ Before deploying any protected endpoint, verify:
485485
## Related Documentation
486486

487487
- [API Documentation Generation](/development/backend/api) - General API development patterns
488-
- [Authentication System](deploystack/auth) - User authentication implementation
488+
- [Authentication System](/development/backend/auth) - User authentication implementation
489489
- [Role-Based Access Control](/development/backend/roles) - Permission system details

docs/development/backend/api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The DeployStack Backend uses Fastify with Swagger plugins to automatically gener
1717

1818
## 🔒 Security First
1919

20-
**IMPORTANT**: Before developing any protected API endpoints, read the [API Security Best Practices](./api-security.mdx) documentation. It covers critical security patterns including:
20+
**IMPORTANT**: Before developing any protected API endpoints, read the [API Security Best Practices](/development/backend/api-security) documentation. It covers critical security patterns including:
2121

2222
- **Authorization Before Validation**: Why `preValidation` must be used instead of `preHandler` for authorization
2323
- **Proper Error Responses**: Ensuring unauthorized users get 403 Forbidden, not validation errors

docs/development/backend/auth.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Authentication System
3+
description: Complete guide to implementing user authentication in DeployStack Backend.
4+
---
5+
6+
# DeployStack Authentication System

docs/development/backend/global-settings.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -930,7 +930,7 @@ Key points for plugin-contributed settings:
930930
- **Declaration**: Plugins declare global settings via a `globalSettingsExtension` property in their main class.
931931
- **Initialization**: The `PluginManager` processes these definitions at startup, creating new groups and settings if they don't already exist.
932932
- **Precedence**: Core global settings always take precedence. If a plugin tries to define a setting with a key that already exists (either from core or another plugin), the plugin's definition for that specific key is ignored.
933-
- **Documentation**: For details on how plugins can define global settings, refer to the [PLUGINS.MD](PLUGINS.MD) document.
933+
- **Documentation**: For details on how plugins can define global settings, refer to the [Backend Plugins Docs](/development/backend/plugins) document.
934934

935935
## Helper Methods API Reference
936936

docs/development/backend/oauth.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ For programmatic API access by CLI tools and applications:
2828

2929
The OAuth2 server enables CLI tools and applications to access DeployStack APIs securely using Bearer tokens.
3030

31-
For OAuth2 security details including PKCE, token security, authorization flow security, and Bearer token authentication, see the [Security Policy](./security.mdx#oauth2-server-security).
31+
For OAuth2 security details including PKCE, token security, authorization flow security, and Bearer token authentication, see the [Security Policy](/development/backend/security#oauth2-server-security).
3232

3333
### Database Schema
3434

docs/development/backend/roles.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ fastify.post('/teams/:teamId/resources', {
106106
}, handler);
107107
```
108108

109-
See [API Security Best Practices](./api-security.mdx) for detailed information about team-aware permissions and security patterns.
109+
See [API Security Best Practices](/development/backend/api-security) for detailed information about team-aware permissions and security patterns.
110110

111111
### Programmatic Checks
112112

docs/development/backend/security.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ The OAuth2 server implementation follows RFC 6749 and RFC 7636 security standard
105105
- **Scope Enforcement:** Middleware validates required scopes per endpoint
106106
- **Dual Authentication:** Seamless support for both cookies and Bearer tokens
107107

108-
For implementation details, see the [OAuth Implementation Guide](./oauth.mdx).
108+
For implementation details, see the [Backend OAuth Implementation Guide](/development/backend/oauth).
109109

110110
## Dependencies
111111

docs/development/backend/test.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ console.log('User created:', user);
133133
server.log.info('User created', { userId: user.id });
134134
```
135135

136-
See the [Backend Logging Guide](./logging.mdx) for complete logging best practices.
136+
See the [Backend Logging Guide](/development/backend/logging) for complete logging best practices.
137137

138138
## Writing New Tests
139139

docs/development/gateway/caching-system.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Tool discovery is automatically triggered during:
9696
The discovery workflow follows these steps:
9797

9898
1. **Server Enumeration**: Identify all MCP servers configured for the team
99-
2. **Process Communication**: Connect to already-running MCP server processes as described in [Process Management](./process-management)
99+
2. **Process Communication**: Connect to already-running MCP server processes as described in [Gateway Process Management](/development/gateway/process-management)
100100
3. **Tool Interrogation**: Query each running server for its available tools using MCP protocol
101101
4. **Schema Extraction**: Extract complete tool schemas including parameters and descriptions
102102
5. **Namespacing**: Apply server-specific namespacing to prevent tool name conflicts
@@ -175,9 +175,9 @@ The caching system ensures data privacy by:
175175

176176
The caching system integrates seamlessly with other Gateway components:
177177

178-
- **[MCP Configuration Management](./mcp)**: Uses team configurations to determine which servers to discover
179-
- **[Process Management](./process-management)**: Coordinates with process spawning for tool discovery
180-
- **[Project Structure](./structure)**: Implements the centralized architecture through the utils layer
178+
- **[MCP Configuration Management](/development/gateway/mcp)**: Uses team configurations to determine which servers to discover
179+
- **[Gateway Process Management](/development/gateway/process-management)**: Coordinates with process spawning for tool discovery
180+
- **[Gateway Project Structure](/development/gateway/structure)**: Implements the centralized architecture through the utils layer
181181
- **HTTP Proxy Server**: Provides cached tool information for immediate client responses
182182

183183
## Cache Management Operations

docs/development/gateway/index.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -165,11 +165,11 @@ The Gateway works with MCP server configurations in this format:
165165
3. **Persistent Process Startup**: Starts all configured MCP servers as background processes when gateway launches
166166
4. **HTTP Server**: Starts local HTTP server with SSE endpoints immediately available (default: `localhost:9095/sse`)
167167
5. **Request Handling**: Receives MCP requests from development tools and routes to already-running processes
168-
6. **Process Management**: Maintains persistent background processes as described in [Process Management](./process-management)
168+
6. **Process Management**: Maintains persistent background processes as described in [Gateway Process Management](/development/gateway/process-management).
169169
7. **Credential Injection**: Securely injects environment variables into running processes at startup
170170
8. **Tool Routing**: Routes namespaced tool calls to persistent MCP servers via stdio transport
171171

172-
For detailed information about the caching system, see [Caching System](./caching-system).
172+
For detailed information about the caching system, see [Gateway Caching System](/development/gateway/caching-system).
173173

174174
## Language Support
175175

@@ -227,5 +227,3 @@ The Gateway is actively under development. Key areas for contribution:
227227
- **Phase 3**: Support for remote MCP servers (HTTP transport)
228228
- **Phase 4**: Advanced monitoring and analytics
229229
- **Future**: Plugin system for custom MCP server types
230-
231-
For detailed contribution guidelines, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).

0 commit comments

Comments
 (0)