Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions website/docs/guides/api/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@ curl -H "Authorization: Bearer your_reader_token" \
## Next Steps
- [Explore API Reference →](/guides/api/openapi)
- [View Code Examples →](/guides/api/examples)
- [Explore API Reference →](/docs/guides/api/openapi)
- [View Code Examples →](/docs/guides/api/examples)
- [Check OpenAPI Spec →](https://github.com/dream-sports-labs/checkmate/blob/master/openapi.yaml)
4 changes: 2 additions & 2 deletions website/docs/guides/api/examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -845,8 +845,8 @@ def download_and_analyze_report(project_id):
## Next Steps
- [View API Reference →](/guides/api/openapi)
- [Learn about Authentication →](/guides/api/authentication)
- [View API Reference →](/docs/guides/api/openapi)
- [Learn about Authentication →](/docs/guides/api/authentication)
- [Download OpenAPI Spec →](https://github.com/dream-sports-labs/checkmate/blob/master/openapi.yaml)
:::tip
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ Production: https://your-production-domain.com
<Card title="Authentication" icon="key">
Learn how to authenticate your API requests using session cookies or API tokens.

[View Authentication Guide →](/guides/api/authentication)
[View Authentication Guide →](/docs/guides/api/authentication)
</Card>

<Card title="API Reference" icon="open-book">
Explore all available endpoints with request/response examples.

[View API Reference →](/guides/api/openapi)
[View API Reference →](/docs/guides/api/openapi)
</Card>

<Card title="Examples" icon="puzzle">
Ready-to-use code examples in multiple languages.

[View Examples →](/guides/api/examples)
[View Examples →](/docs/guides/api/examples)
</Card>

<Card title="OpenAPI Spec" icon="document">
Expand Down
6 changes: 3 additions & 3 deletions website/docs/guides/api/openapi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ When the API changes:

## Next Steps

- [Try Code Examples →](/guides/api/examples)
- [Learn Authentication →](/guides/api/authentication)
- [API Overview →](/guides/api)
- [Try Code Examples →](/docs/guides/api/examples)
- [Learn Authentication →](/docs/guides/api/authentication)
- [API Overview →](/docs/guides/api/)

6 changes: 3 additions & 3 deletions website/docs/guides/projects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,6 @@ From each project card:

## Next Steps

- [Manage Test Cases](/guides/tests/tests) - Create and organize tests
- [Execute Test Runs](/guides/runs/runs) - Run and track testing progress
- [Configure RBAC](/project/rbac) - Set up team permissions
- [Manage Test Cases](/docs/guides/tests/) - Create and organize tests
- [Execute Test Runs](/docs/guides/runs/) - Run and track testing progress
- [Configure RBAC](/docs/project/rbac) - Set up team permissions
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,6 @@ Click **Download** → CSV downloads with all test results and metadata

## Next Steps

- [View Run Details](/guides/runs/run-detail) - Learn about the run detail page
- [Manage Tests](/guides/tests/tests) - Create and organize test cases
- [Bulk Import](/guides/tests/bulk-addition) - Import tests in bulk
- [View Run Details](/docs/guides/runs/run-detail) - Learn about the run detail page
- [Manage Tests](/docs/guides/tests/) - Create and organize test cases
- [Bulk Import](/docs/guides/tests/bulk-addition) - Import tests in bulk
6 changes: 3 additions & 3 deletions website/docs/guides/runs/run-detail.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,6 @@ Click **Download** → CSV file downloads with complete test results

## Next Steps

- [Manage Runs](/guides/runs/runs) - Learn about run creation and management
- [Manage Tests](/guides/tests/tests) - View and organize test cases
- [Bulk Import](/guides/tests/bulk-addition) - Import tests in bulk
- [Manage Runs](/docs/guides/runs/) - Learn about run creation and management
- [Manage Tests](/docs/guides/tests/) - View and organize test cases
- [Bulk Import](/docs/guides/tests/bulk-addition) - Import tests in bulk
6 changes: 3 additions & 3 deletions website/docs/guides/tests/bulk-addition.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,6 @@ This ensures links and references remain intact during migration.

## Next Steps

- [Manage Tests](/guides/tests/tests) - View and organize imported tests
- [Execute Runs](/guides/runs/runs) - Run your imported test cases
- [Filter Tests](/guides/tests/tests#view--filter-tests) - Use advanced filtering options
- [Manage Tests](/docs/guides/tests/) - View and organize imported tests
- [Execute Runs](/docs/guides/runs/) - Run your imported test cases
- [Filter Tests](/docs/guides/tests/#view--filter-tests) - Use advanced filtering options
Original file line number Diff line number Diff line change
Expand Up @@ -118,5 +118,5 @@ Click **New** → **Add Section** or create while adding tests

## Next Steps

- [Bulk Addition](/guides/tests/bulk-addition) - Import tests via CSV/JSON
- [Execute Test Runs](/guides/runs/runs) - Run and track test execution
- [Bulk Addition](/docs/guides/tests/bulk-addition) - Import tests via CSV/JSON
- [Execute Test Runs](/docs/guides/runs/) - Run and track test execution
8 changes: 4 additions & 4 deletions website/docs/guides/user-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Your current role and permissions are displayed on the User Details page.
- **User** - Create and modify tests and runs
- **Reader** - View-only access

See [RBAC Documentation](/project/rbac) for detailed permissions by role.
See [RBAC Documentation](/docs/project/rbac) for detailed permissions by role.

## Admin Panel

Expand All @@ -67,6 +67,6 @@ Administrators can access the Admin Panel to manage users across the organizatio

## Next Steps

- [RBAC Documentation](/project/rbac) - Understand role permissions
- [API Authentication](/guides/api/authentication) - Learn how to use tokens
- [API Reference](/guides/api/openapi) - Explore available APIs
- [RBAC Documentation](/docs/project/rbac) - Understand role permissions
- [API Authentication](/docs/guides/api/authentication) - Learn how to use tokens
- [API Reference](/docs/guides/api/openapi) - Explore available APIs
2 changes: 1 addition & 1 deletion website/docs/project/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Docker Compose setup gets you running in minutes.
<Card title="🔌 API Documentation" icon="puzzle">
Integrate with your tools

[View APIs →](/docs/guides/api)
[View APIs →](/docs/guides/api/)
</Card>

<Card title="🏗️ Architecture" icon="seti:config">
Expand Down
8 changes: 4 additions & 4 deletions website/docs/project/rbac.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Roles are hierarchical - higher roles inherit all permissions from lower roles.

## API Permissions

Each role has access to specific API endpoints. See the [API Documentation](/guides/api) for detailed endpoint information.
Each role has access to specific API endpoints. See the [API Documentation](/docs/guides/api/) for detailed endpoint information.

### Admin-Only APIs

Expand Down Expand Up @@ -126,6 +126,6 @@ Reader role has access to all read-only endpoints:

## Next Steps

- [User Settings](/guides/user-settings) - Manage your profile and tokens
- [API Authentication](/guides/api/authentication) - Learn how to use your tokens
- [API Reference](/guides/api/openapi) - Explore all available endpoints
- [User Settings](/docs/guides/user-settings) - Manage your profile and tokens
- [API Authentication](/docs/guides/api/authentication) - Learn how to use your tokens
- [API Reference](/docs/guides/api/openapi) - Explore all available endpoints
6 changes: 3 additions & 3 deletions website/docs/project/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -405,19 +405,19 @@ LOG_LEVEL=info
<Card title="User Guide" icon="rocket">
Learn how to use Checkmate

[Get Started →](/guides/projects)
[Get Started →](/docs/guides/projects)
</Card>

<Card title="System Architecture" icon="puzzle">
Understand how Checkmate works

[Read Docs →](/tech/architecture)
[Read Docs →](/docs/tech/architecture)
</Card>

<Card title="API Documentation" icon="open-book">
Integrate with Checkmate APIs

[View APIs →](/guides/api)
[View APIs →](/docs/guides/api/)
</Card>

<Card title="Contributing" icon="github">
Expand Down
16 changes: 8 additions & 8 deletions website/docs/tech/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,7 @@ All API responses follow a consistent structure:
1. **Session Cookies** - Web application (automatic)
2. **API Tokens** - External integrations (Bearer token)

See [API Documentation](/guides/api) for detailed endpoint reference.
See [API Documentation](/docs/guides/api/) for detailed endpoint reference.

---

Expand Down Expand Up @@ -731,18 +731,18 @@ main (production)

## Additional Resources

- [Database Design](/tech/database) - Detailed schema documentation
- [API Documentation](/guides/api) - Complete API reference
- [User Guide](/guides/projects) - End-user documentation
- [RBAC Configuration](/project/rbac) - Role and permission details
- [Database Design](/docs/tech/database) - Detailed schema documentation
- [API Documentation](/docs/guides/api/) - Complete API reference
- [User Guide](/docs/guides/projects) - End-user documentation
- [RBAC Configuration](/docs/project/rbac) - Role and permission details
- [GitHub Repository](https://github.com/dream-sports-labs/checkmate) - Source code

---

## Next Steps for Developers

- [Setup Guide](/project/setup) - Get Checkmate running locally
- [Database Design](/tech/database) - Understand the data model
- [API Reference](/guides/api/openapi) - Explore available endpoints
- [Setup Guide](/docs/project/setup) - Get Checkmate running locally
- [Database Design](/docs/tech/database) - Understand the data model
- [API Reference](/docs/guides/api/openapi) - Explore available endpoints
- [Contributing Guide](https://github.com/dream-sports-labs/checkmate/blob/master/CONTRIBUTING.md) - Contribution guidelines

6 changes: 3 additions & 3 deletions website/docs/tech/database.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@ const tests = await db

## Additional Resources

- [System Architecture](/tech/architecture) - Overall system design
- [System Architecture](/docs/tech/architecture) - Overall system design
- [Drizzle ORM Documentation](https://orm.drizzle.team/) - ORM reference
- [MySQL 8.0 Documentation](https://dev.mysql.com/doc/refman/8.0/en/) - Database reference
- Schema Visualization: Import `/sql/_schema.sql` into [dbdiagram.io](https://dbdiagram.io/)
Expand All @@ -513,7 +513,7 @@ const tests = await db

## Next Steps

- [Setup Guide](/project/setup) - Configure database locally
- [API Reference](/guides/api/openapi) - Understand data flows
- [Setup Guide](/docs/project/setup) - Configure database locally
- [API Reference](/docs/guides/api/openapi) - Understand data flows
- [Contributing](https://github.com/dream-sports-labs/checkmate/blob/master/CONTRIBUTING.md) - Schema change process

6 changes: 3 additions & 3 deletions website/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ const sidebars: SidebarsConfig = {
{
type: 'category',
label: 'Tests',
items: ['guides/tests/tests', 'guides/tests/bulk-addition'],
items: ['guides/tests/index', 'guides/tests/bulk-addition'],
},
{
type: 'category',
label: 'Runs',
items: ['guides/runs/runs', 'guides/runs/run-detail'],
items: ['guides/runs/index', 'guides/runs/run-detail'],
},
{
type: 'category',
Expand All @@ -39,7 +39,7 @@ const sidebars: SidebarsConfig = {
type: 'category',
label: 'API Documentation',
items: [
'guides/api',
'guides/api/index',
'guides/api/authentication',
'guides/api/examples',
'guides/api/openapi',
Expand Down