|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to FixFX will be documented in this file. |
| 4 | + |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## [1.0.0] - 2026-01-25 |
| 9 | + |
| 10 | +### Added |
| 11 | + |
| 12 | +#### Backend Integration |
| 13 | +- **Go Backend API Integration** - Complete frontend migration to use Go backend services |
| 14 | + - Artifacts API endpoint integration (`/api/artifacts`) |
| 15 | + - Natives API endpoint integration (`/api/natives`) |
| 16 | + - Contributors API endpoint integration (`/api/contributors`) |
| 17 | + - Source API endpoint integration (`/api/source`) |
| 18 | + - Environment-aware API_URL configuration using `NEXT_PUBLIC_API_URL` env var |
| 19 | + - Production default URL: `https://core.fixfx.wiki` |
| 20 | + - Development override support for local backend |
| 21 | + |
| 22 | +#### Analytics |
| 23 | +- **Ackee Analytics Integration** - User tracking and analytics |
| 24 | + - Added Ackee tracker script to root layout |
| 25 | + - Server: `https://ackee.bytebrush.dev` |
| 26 | + - Domain ID: `cda143c2-45f9-4884-96b6-9e73ffecaf15` |
| 27 | + - Automatic page view and interaction tracking |
| 28 | + |
| 29 | +#### Documentation |
| 30 | +- **API Documentation Updates** - Complete rewrite for Go backend |
| 31 | + - `content/docs/core/api/artifacts.mdx` - Artifacts API documentation |
| 32 | + - `content/docs/core/api/natives.mdx` - Natives API documentation with usage examples |
| 33 | + - `content/docs/core/api/contributors.mdx` - Contributors API documentation |
| 34 | + - Includes endpoint specifications, query parameters, and response formats |
| 35 | + - JavaScript, Lua, and C# usage examples |
| 36 | + |
| 37 | +### Changed |
| 38 | + |
| 39 | +#### Components |
| 40 | +- **FileSource Component** - Server component that reads and displays source code files directly in documentation |
| 41 | + - Located at `app/components/file-source.tsx` |
| 42 | + - Supports syntax highlighting via DynamicCodeBlock |
| 43 | + - Fetches file content through secure API route |
| 44 | + |
| 45 | +- **ImageModal Component** - Click-to-expand image viewer for better mobile experience |
| 46 | + - Located at `app/components/image-modal.tsx` |
| 47 | + - Uses React Portal to render above all content |
| 48 | + - Features dark overlay, close button, and optional title caption |
| 49 | + - Prevents body scroll when open |
| 50 | + |
| 51 | +- **SourceCode Component** - Client wrapper for DynamicCodeBlock with custom styling |
| 52 | + - Located at `packages/ui/src/components/source-code.tsx` |
| 53 | + - Supports multiple languages with proper syntax highlighting |
| 54 | + - Optional title bar display |
| 55 | + |
| 56 | +#### API Routes |
| 57 | +- **Source API** (`/api/source`) - Securely serves file contents for documentation |
| 58 | + - Whitelisted paths for security (`lib/artifacts/`, `packages/`) |
| 59 | + - Prevents path traversal attacks |
| 60 | + - Returns file contents as JSON |
| 61 | + |
| 62 | +#### Documentation |
| 63 | +- **txAdmin Windows Installation Guide** (`content/docs/txadmin/windows/install.mdx`) |
| 64 | + - Complete step-by-step installation process |
| 65 | + - PowerShell commands for artifact download |
| 66 | + - Screenshots with ImageModal for better viewing |
| 67 | + - CFX authorization and master account setup |
| 68 | + - Server deployment with recipes |
| 69 | + - License key generation guide |
| 70 | + |
| 71 | +- **txAdmin Windows Overview** (`content/docs/txadmin/windows/index.mdx`) |
| 72 | + - System requirements (hardware and software) |
| 73 | + - Quick overview of installation process |
| 74 | + - Links to detailed installation guide |
| 75 | + |
| 76 | +- **txAdmin Config Editor Guide** (`content/docs/txadmin/configuration.mdx`) |
| 77 | + - Complete explanation of all server.cfg options |
| 78 | + - Server identity settings (sv_hostname, sv_projectName, etc.) |
| 79 | + - Server configuration (sv_maxclients, endpoints, etc.) |
| 80 | + - Resource management section |
| 81 | + - Admin permissions and ACE rules |
| 82 | + - Common configuration scenarios |
| 83 | + - Troubleshooting guide |
| 84 | + |
| 85 | +- **txAdmin Server Management Guide** (`content/docs/txadmin/server-management.mdx`) |
| 86 | + - Dashboard overview and metrics |
| 87 | + - Live Console usage and commands |
| 88 | + - Players management and search |
| 89 | + - Resources management |
| 90 | + - Server Log and filtering |
| 91 | + - History and audit trail |
| 92 | + - Player Drops analytics |
| 93 | + - Whitelist management |
| 94 | + - Admin account creation and permissions |
| 95 | + - Best practices (daily, weekly, monthly tasks) |
| 96 | + - Troubleshooting common issues |
| 97 | + |
| 98 | +#### Animations |
| 99 | +- **Indeterminate Progress Animation** - Added loading animation for Progress component |
| 100 | + - Added `indeterminate-progress` keyframes to `tailwind.config.ts` |
| 101 | + - Smooth left-to-right loading animation |
| 102 | + |
| 103 | +### Changed |
| 104 | + |
| 105 | +#### Components |
| 106 | +- **Progress Component** (`packages/ui/src/components/progress.tsx`) |
| 107 | + - Added `indeterminate` prop support |
| 108 | + - Uses Tailwind animation class instead of inline CSS |
| 109 | + - Properly handles both determinate and indeterminate states |
| 110 | + |
| 111 | +#### Documentation Cleanup |
| 112 | +- **vMenu Documentation** - Removed fabricated information |
| 113 | + - Removed fake build numbers and version requirements |
| 114 | + - Removed incorrect convar names that don't exist |
| 115 | + - Corrected feature descriptions to match actual vMenu capabilities |
| 116 | + |
| 117 | +- **txAdmin Documentation** - Removed fabricated information |
| 118 | + - Removed fake build numbers and minimum version requirements |
| 119 | + - Removed non-existent convars and configuration options |
| 120 | + - Corrected setup instructions to match actual txAdmin behavior |
| 121 | + |
| 122 | +- **ESX Framework Documentation** - Removed fabricated information |
| 123 | + - Removed fake version numbers and compatibility matrices |
| 124 | + - Removed non-existent configuration options |
| 125 | + - Corrected database setup instructions |
| 126 | + |
| 127 | +- **QBCore Framework Documentation** - Removed fabricated information |
| 128 | + - Removed fake version numbers and build requirements |
| 129 | + - Removed non-existent functions and exports |
| 130 | + - Corrected resource dependencies |
| 131 | + |
| 132 | +- **CFX Documentation** - Removed fabricated information |
| 133 | + - Removed fake artifact build numbers |
| 134 | + - Removed non-existent server commands |
| 135 | + - Corrected performance optimization tips |
| 136 | + |
| 137 | +### Fixed |
| 138 | + |
| 139 | +- **Progress Component Loading Animation** - Animation was not working because CSS keyframes were missing |
| 140 | + - Added proper keyframes to Tailwind config |
| 141 | + - Component now animates correctly when `value={undefined}` |
| 142 | + |
| 143 | +- **ImageModal Positioning** - Modal was appearing in wrong position due to CSS stacking context |
| 144 | + - Implemented React Portal to render directly to document.body |
| 145 | + - Uses inline styles with high z-index to ensure proper layering |
| 146 | + - Prevents body scroll when modal is open |
| 147 | + |
| 148 | +- **FileSource Component** - Initial implementation failed due to `fs` module in client bundle |
| 149 | + - Moved file reading to API route |
| 150 | + - Client component fetches via `/api/source` endpoint |
| 151 | + - Proper error handling and loading states |
| 152 | + |
| 153 | +### Removed |
| 154 | + |
| 155 | +- Removed `file-source.tsx` from `packages/ui/src/components/` (moved to `app/components/`) |
| 156 | +- Removed fabricated documentation content across multiple files |
| 157 | + |
| 158 | +### Security |
| 159 | + |
| 160 | +- **Source API** includes path whitelisting to prevent unauthorized file access |
| 161 | +- **Source API** blocks path traversal attempts (rejects paths containing `..`) |
| 162 | + |
| 163 | +--- |
| 164 | + |
| 165 | +## Version History |
| 166 | + |
| 167 | +| Version | Date | Description | |
| 168 | +|---------|------|-------------| |
| 169 | +| 1.0.0 | 2026-01-25 | Initial rewrite with documentation cleanup, new components, and txAdmin guides | |
| 170 | + |
| 171 | +--- |
0 commit comments