Skip to content

Commit dd2c186

Browse files
authored
Docs: Add v2 rewrite while preserving v1.0 to support ODE major release 1.0 (#7)
1 parent ff80e3b commit dd2c186

File tree

263 files changed

+30945
-5633
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

263 files changed

+30945
-5633
lines changed

.github/workflows/deploy.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020

2121
- uses: actions/setup-node@v4
2222
with:
23-
node-version: 18
23+
node-version: 20
2424
cache: npm
2525

2626
- name: Install dependencies
@@ -45,7 +45,7 @@ jobs:
4545

4646
- uses: actions/setup-node@v4
4747
with:
48-
node-version: 18
48+
node-version: 20
4949
cache: npm
5050

5151
- name: Install dependencies

.gitignore

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,41 @@
11
# Dependencies
2-
/node_modules
2+
node_modules/
33

4-
# Production
5-
/build
4+
# Production build
5+
build/
6+
.docusaurus/
7+
.cache-loader/
68

79
# Generated files
8-
.docusaurus
9-
.cache-loader
10+
.docusaurus/
11+
.cache/
1012

1113
# Misc
1214
.DS_Store
15+
.env
1316
.env.local
1417
.env.development.local
1518
.env.test.local
1619
.env.production.local
1720

21+
# Logs
1822
npm-debug.log*
1923
yarn-debug.log*
2024
yarn-error.log*
25+
lerna-debug.log*
26+
27+
# Editor directories and files
28+
.idea/
29+
.vscode/
30+
*.swp
31+
*.swo
32+
*~
33+
.project
34+
.classpath
35+
.settings/
36+
*.sublime-workspace
37+
38+
# OS
39+
.DS_Store
40+
Thumbs.db
41+

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,4 @@ The website is deployed automatically using GitHub Actions when changes are push
6262
2. Runs full Docusaurus build
6363
3. Deploys to GitHub Pages (only if all checks pass)
6464

65-
Broken links or validation errors will prevent deployment.
65+
Broken links or validation errors will prevent deployment.

babel.config.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};
4+

create-placeholders.sh

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
#!/bin/bash
2+
# Create placeholder markdown files for all documentation pages
3+
4+
# Guides - Forms
5+
echo "---\nsidebar_position: 2\n---\n\n# Schema Definition\n\n[Placeholder: Content will be added]" > docs/guides/forms/schema-definition.md
6+
echo "---\nsidebar_position: 3\n---\n\n# UI Schema\n\n[Placeholder: Content will be added]" > docs/guides/forms/ui-schema.md
7+
echo "---\nsidebar_position: 4\n---\n\n# Validation\n\n[Placeholder: Content will be added]" > docs/guides/forms/validation.md
8+
echo "---\nsidebar_position: 5\n---\n\n# Conditional Logic\n\n[Placeholder: Content will be added]" > docs/guides/forms/advanced-features.md
9+
10+
# Guides - Custom Apps
11+
echo "---\nsidebar_position: 1\n---\n\n# Custom Applications Overview\n\n[Placeholder: Content will be added]" > docs/guides/custom-apps/overview.md
12+
echo "---\nsidebar_position: 2\n---\n\n# Building Custom Applications\n\n[Placeholder: Content will be added]" > docs/guides/custom-apps/building.md
13+
echo "---\nsidebar_position: 3\n---\n\n# App Bundle Structure\n\n[Placeholder: Content will be added]" > docs/guides/custom-apps/app-bundle-structure.md
14+
echo "---\nsidebar_position: 4\n---\n\n# Deployment\n\n[Placeholder: Content will be added]" > docs/guides/custom-apps/deployment.md
15+
echo "---\nsidebar_position: 5\n---\n\n# Custom Renderers\n\n[Placeholder: Content will be added]" > docs/guides/custom-apps/custom-renderers.md
16+
17+
# Guides - Deployment
18+
echo "---\nsidebar_position: 1\n---\n\n# Deployment Overview\n\n[Placeholder: Content will be added]" > docs/guides/deployment/overview.md
19+
echo "---\nsidebar_position: 2\n---\n\n# Docker Deployment\n\n[Placeholder: Content will be added]" > docs/guides/deployment/docker.md
20+
echo "---\nsidebar_position: 3\n---\n\n# Production Deployment\n\n[Placeholder: Content will be added]" > docs/guides/deployment/production.md
21+
echo "---\nsidebar_position: 4\n---\n\n# Monitoring\n\n[Placeholder: Content will be added]" > docs/guides/deployment/monitoring.md
22+
23+
# Guides - Other
24+
echo "---\nsidebar_position: 5\n---\n\n# User Management\n\n[Placeholder: Content will be added]" > docs/guides/user-management.md
25+
echo "---\nsidebar_position: 6\n---\n\n# Branding\n\n[Placeholder: Content will be added]" > docs/guides/branding.md
26+
echo "---\nsidebar_position: 7\n---\n\n# Translations\n\n[Placeholder: Content will be added]" > docs/guides/translations.md
27+
28+
# Reference - API
29+
echo "---\nsidebar_position: 1\n---\n\n# API Overview\n\n[Placeholder: Content will be added]" > docs/reference/api/overview.md
30+
echo "---\nsidebar_position: 2\n---\n\n# Authentication\n\n[Placeholder: Content will be added]" > docs/reference/api/authentication.md
31+
echo "---\nsidebar_position: 3\n---\n\n# API Endpoints\n\n[Placeholder: Content will be added]" > docs/reference/api/endpoints.md
32+
33+
# Reference - Configuration
34+
echo "---\nsidebar_position: 1\n---\n\n# Server Configuration\n\n[Placeholder: Content will be added]" > docs/reference/configuration/server.md
35+
echo "---\nsidebar_position: 2\n---\n\n# Client Configuration\n\n[Placeholder: Content will be added]" > docs/reference/configuration/client.md
36+
37+
# Reference - Other
38+
echo "---\nsidebar_position: 2\n---\n\n# Form Specifications\n\n[Placeholder: Content will be added]" > docs/reference/form-specifications.md
39+
echo "---\nsidebar_position: 3\n---\n\n# App Bundle Format\n\n[Placeholder: Content will be added]" > docs/reference/app-bundle-format.md
40+
41+
# Reference - Components
42+
echo "---\nsidebar_position: 1\n---\n\n# Formulus\n\n[Placeholder: Content will be added]" > docs/reference/components/formulus.md
43+
echo "---\nsidebar_position: 2\n---\n\n# Synkronus\n\n[Placeholder: Content will be added]" > docs/reference/components/synkronus.md
44+
echo "---\nsidebar_position: 3\n---\n\n# Synkronus CLI\n\n[Placeholder: Content will be added]" > docs/reference/components/synkronus-cli.md
45+
echo "---\nsidebar_position: 4\n---\n\n# Formplayer\n\n[Placeholder: Content will be added]" > docs/reference/components/formplayer.md
46+
47+
# Development - Getting Started
48+
echo "---\nsidebar_position: 1\n---\n\n# Development Setup\n\n[Placeholder: Content will be added]" > docs/development/getting-started/setup.md
49+
echo "---\nsidebar_position: 2\n---\n\n# Architecture Overview\n\n[Placeholder: Content will be added]" > docs/development/getting-started/architecture.md
50+
echo "---\nsidebar_position: 3\n---\n\n# Codebase Overview\n\n[Placeholder: Content will be added]" > docs/development/getting-started/codebase-overview.md
51+
52+
# Development - Architecture
53+
echo "---\nsidebar_position: 1\n---\n\n# Architecture Overview\n\n[Placeholder: Content will be added]" > docs/development/architecture/overview.md
54+
echo "---\nsidebar_position: 2\n---\n\n# Components\n\n[Placeholder: Content will be added]" > docs/development/architecture/components.md
55+
echo "---\nsidebar_position: 3\n---\n\n# Data Flow\n\n[Placeholder: Content will be added]" > docs/development/architecture/data-flow.md
56+
echo "---\nsidebar_position: 4\n---\n\n# Sync Protocol\n\n[Placeholder: Content will be added]" > docs/development/architecture/sync-protocol.md
57+
echo "---\nsidebar_position: 5\n---\n\n# Database\n\n[Placeholder: Content will be added]" > docs/development/architecture/database.md
58+
59+
# Development - Contributing
60+
echo "---\nsidebar_position: 1\n---\n\n# Contributing Guide\n\n[Placeholder: Content will be added]" > docs/development/contributing/guide.md
61+
echo "---\nsidebar_position: 2\n---\n\n# Code of Conduct\n\n[Placeholder: Content will be added]" > docs/development/contributing/code-of-conduct.md
62+
echo "---\nsidebar_position: 3\n---\n\n# First Contribution\n\n[Placeholder: Content will be added]" > docs/development/contributing/first-contribution.md
63+
echo "---\nsidebar_position: 4\n---\n\n# Coding Standards\n\n[Placeholder: Content will be added]" > docs/development/contributing/coding-standards.md
64+
65+
# Development - Building
66+
echo "---\nsidebar_position: 1\n---\n\n# Building from Source\n\n[Placeholder: Content will be added]" > docs/development/building/from-source.md
67+
echo "---\nsidebar_position: 2\n---\n\n# Building Components\n\n[Placeholder: Content will be added]" > docs/development/building/components.md
68+
echo "---\nsidebar_position: 3\n---\n\n# Testing\n\n[Placeholder: Content will be added]" > docs/development/building/testing.md
69+
echo "---\nsidebar_position: 4\n---\n\n# CI/CD Pipeline\n\n[Placeholder: Content will be added]" > docs/development/building/ci-cd.md
70+
71+
# Development - Extending
72+
echo "---\nsidebar_position: 1\n---\n\n# Extending ODE Overview\n\n[Placeholder: Content will be added]" > docs/development/extending/overview.md
73+
echo "---\nsidebar_position: 2\n---\n\n# Custom Renderers\n\n[Placeholder: Content will be added]" > docs/development/extending/custom-renderers.md
74+
echo "---\nsidebar_position: 3\n---\n\n# Plugins\n\n[Placeholder: Content will be added]" > docs/development/extending/plugins.md
75+
echo "---\nsidebar_position: 4\n---\n\n# Internal APIs\n\n[Placeholder: Content will be added]" > docs/development/extending/internal-apis.md
76+
77+
# Development - Technical
78+
echo "---\nsidebar_position: 1\n---\n\n# Database Schema\n\n[Placeholder: Content will be added]" > docs/development/technical/database-schema.md
79+
echo "---\nsidebar_position: 2\n---\n\n# Sync Protocol\n\n[Placeholder: Content will be added]" > docs/development/technical/sync-protocol.md
80+
echo "---\nsidebar_position: 3\n---\n\n# Security\n\n[Placeholder: Content will be added]" > docs/development/technical/security.md
81+
echo "---\nsidebar_position: 4\n---\n\n# Performance\n\n[Placeholder: Content will be added]" > docs/development/technical/performance.md
82+
83+
# Community
84+
echo "---\nsidebar_position: 2\n---\n\n# Getting Help\n\n[Placeholder: Content will be added]" > docs/community/getting-help.md
85+
echo "---\nsidebar_position: 3\n---\n\n# Reporting Issues\n\n[Placeholder: Content will be added]" > docs/community/reporting-issues.md
86+
echo "---\nsidebar_position: 4\n---\n\n# Examples\n\n[Placeholder: Content will be added]" > docs/community/examples.md
87+
echo "---\nsidebar_position: 5\n---\n\n# Projects\n\n[Placeholder: Content will be added]" > docs/community/projects.md
88+
89+
echo "Placeholder files created successfully"

docs/.gitkeep

Whitespace-only changes.

docs/build/_category_.json

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/build/branding.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

docs/build/custom-applications/app-bundle-structure.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

docs/build/custom-applications/custom-renderers.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

0 commit comments

Comments
 (0)