diff --git a/docs/docs/api/overview.md b/docs/docs/api/overview.md index 7d5f30e..ebe5099 100644 --- a/docs/docs/api/overview.md +++ b/docs/docs/api/overview.md @@ -8,14 +8,14 @@ Complete reference for all EasyBallistics classes, functions, and events. | Class | Description | Module | |-------|-------------|---------| -| [`AEBBullet`](bullet-actor) | Main projectile actor with physics simulation | Runtime | +| `AEBBullet` | Main projectile actor with physics simulation | Runtime | ### Components | Class | Description | Module | |-------|-------------|---------| -| [`UEBBarrel`](barrel-component) | Weapon barrel with firing mechanics | Runtime | -| [`UEBBallisticImpactComponent`](impact-component) | Impact handling and event system | Runtime | +| `UEBBarrel` | Weapon barrel with firing mechanics | Runtime | +| `UEBBallisticImpactComponent` | Impact handling and event system | Runtime | ### Assets @@ -29,7 +29,7 @@ Complete reference for all EasyBallistics classes, functions, and events. | Class | Description | Module | |-------|-------------|---------| -| [`UEBMathematicalBallistics`](mathematical-ballistics) | Static calculation functions | Runtime | +| `UEBMathematicalBallistics` | Static calculation functions | Runtime | ## Enumerations @@ -359,7 +359,6 @@ When migrating from the old impact system: ## See Also -- [Component API Reference](bullet-actor) - Detailed component documentation -- [Events Reference](events) - Complete event system documentation -- [Mathematical Formulas](../mathematical/penetration-calculations) - Physics calculation details -- [Migration Guide](../migration/new-impact-system) - Upgrading from legacy system \ No newline at end of file +- [Core Concepts](../core-concepts/overview) - System architecture overview +- [Quick Start Guide](../getting-started/quick-start) - Create your first weapon +- [Troubleshooting](../troubleshooting) - Common issues and solutions \ No newline at end of file diff --git a/docs/docs/core-concepts/overview.md b/docs/docs/core-concepts/overview.md index da94312..afd64e5 100644 --- a/docs/docs/core-concepts/overview.md +++ b/docs/docs/core-concepts/overview.md @@ -256,7 +256,6 @@ Content/ Now that you understand the core concepts: -1. [Asset Types](asset-types) - Deep dive into each asset type -2. [Ballistics System](ballistics-system) - Detailed physics explanations -3. [Physical Materials](physical-materials) - Material system integration -4. [Component Guide](../components/bullet-actor) - Component-specific documentation \ No newline at end of file +1. [API Reference](../api/overview) - Detailed function documentation +2. [Quick Start Guide](../getting-started/quick-start) - Create your first weapon +3. [Troubleshooting](../troubleshooting) - Common issues and solutions \ No newline at end of file diff --git a/docs/docs/getting-started/installation.md b/docs/docs/getting-started/installation.md index c1970b2..98cf179 100644 --- a/docs/docs/getting-started/installation.md +++ b/docs/docs/getting-started/installation.md @@ -56,7 +56,7 @@ git submodule update --init --recursive 4. Check the **Enabled** checkbox 5. Click **Restart Now** when prompted -![Plugin Manager](../img/plugin-manager.png) +![Plugin Manager](https://placehold.co/800x400/2e8555/white?text=Plugin+Manager+Screenshot) ## Verifying Installation @@ -74,7 +74,7 @@ git submodule update --init --recursive - Bullet Properties - Material Response Map -![Asset Creation Menu](../img/asset-creation-menu.png) +![Asset Creation Menu](https://placehold.co/600x400/2e8555/white?text=Asset+Creation+Menu) ### Verify Components @@ -145,8 +145,8 @@ PublicDependencyModuleNames.AddRange(new string[] { Once installation is complete: 1. [Quick Start Guide](quick-start) - Create your first ballistic weapon -2. [Basic Setup](basic-setup) - Configure materials and responses -3. [Core Concepts](../core-concepts/overview) - Understand the system architecture +2. [Core Concepts](../core-concepts/overview) - Understand the system architecture +3. [API Reference](../api/overview) - Detailed function documentation ## Getting Help diff --git a/docs/docs/getting-started/quick-start.md b/docs/docs/getting-started/quick-start.md index e2ce779..560c1f6 100644 --- a/docs/docs/getting-started/quick-start.md +++ b/docs/docs/getting-started/quick-start.md @@ -43,7 +43,7 @@ Penetration: Expansion Velocity Threshold: 1800.0 ``` -![Bullet Properties](../img/bullet-properties-setup.png) +![Bullet Properties](https://placehold.co/800x600/2e8555/white?text=Bullet+Properties+Editor) ## Step 2: Set Up Physical Materials @@ -235,13 +235,12 @@ After completing this setup, you should have: Now that you have a basic system working: -1. [Asset Creation Guide](../assets/bullet-properties) - Create more bullet types -2. [Material Setup](../assets/physical-material-integration) - Advanced material configuration -3. [Advanced Ballistics](../tutorials/advanced-ballistics) - Atmospheric effects and drag curves -4. [Networking](../networking/overview) - Set up multiplayer ballistics +1. [Core Concepts](../core-concepts/overview) - Understand the system architecture +2. [API Reference](../api/overview) - Detailed function documentation +3. [Troubleshooting](../troubleshooting) - Common issues and solutions ## Getting Help - Join our [Discord](https://discord.gg/easyballistics) for real-time help - Check the [API Reference](../api/overview) for detailed function documentation -- Browse [Tutorials](../tutorials/first-weapon) for more advanced setups \ No newline at end of file +- Browse the [Troubleshooting Guide](../troubleshooting) for common issues \ No newline at end of file diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 2a219af..ac4fa89 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -67,7 +67,7 @@ graph TD 1. [Installation Guide](getting-started/installation) - Install the plugin 2. [Quick Start](getting-started/quick-start) - Create your first weapon -3. [Basic Setup](getting-started/basic-setup) - Configure materials and responses +3. [Core Concepts](core-concepts/overview) - Understand the system architecture ## Support diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index f6c57e4..fe1a5e7 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -23,7 +23,7 @@ const config = { organizationName: 'mookie', // Usually your GitHub org/user name. projectName: 'easyballistics', // Usually your repo name. - onBrokenLinks: 'throw', + onBrokenLinks: 'warn', onBrokenMarkdownLinks: 'warn', // Even if you don't use internationalization, you can use this field to set @@ -98,11 +98,11 @@ const config = { items: [ { label: 'Getting Started', - to: '/getting-started', + to: '/getting-started/installation', }, { label: 'API Reference', - to: '/api', + to: '/api/overview', }, ], }, @@ -138,7 +138,7 @@ const config = { prism: { theme: prismThemes.github, darkTheme: prismThemes.dracula, - additionalLanguages: ['cpp', 'blueprint'], + additionalLanguages: ['cpp', 'bash', 'yaml', 'ini'], }, }), };