Ref/documentation#8
Merged
Merged
Conversation
- Add sync-docs script to package.json for documentation synchronization - Generate API documentation for enums, structs, and classes across graphics, input, audio, core, physics, drivers, platforms, and test modules - Update internal documentation links to use relative paths instead of absolute URLs - Reorganize documentation structure with new reference, philosophy, and migration directories - Remove obsolete migration overview and physics actor documentation files - Add cursor rules for synced documentation management
- Move platform compatibility, style guide, performance, coding style, graphics guidelines, UI guidelines, and memory guidelines from reference/ to guide/ - Update all internal links across documentation to point to new guide locations - Remove reference/ directory and update CI workflows, config files, and contributing docs - Reorganize guide index to include new standards and compatibility sections - Maintain single canonical source for platform compatibility and build configuration
- Replace architecture overview with unified architecture-index - Combine tilemaps and multi-palette guides into graphics-techniques - Remove redundant files (style-guide, platform-config, resolution-scaling) - Update all internal links to point to correct documentation locations - Add PowerShell script for link verification - Update VitePress sidebar configuration to reflect new structure
- Replace architecture overview with unified architecture-index - Combine tilemaps and multi-palette guides into graphics-techniques - Remove redundant files (style-guide, platform-config, resolution-scaling) - Update all internal links to point to correct documentation locations - Add PowerShell script for link verification - Update VitePress sidebar configuration to reflect new structure
…me-Engine/PixelRoot32-Docs into ref/documentation
The warning about generated content is no longer needed as the documentation generation process is now well-established. This simplifies the main index page for users.
The note referencing external documentation was outdated as the guide now contains comprehensive memory management information internally. This cleanup improves the document's self-contained nature and reduces maintenance overhead.
The documentation now explains the anchor mechanism that prevents a burst of note starts and phrase skipping when a music track begins playback. This ensures the first scheduled note executes correctly in the initial audio block.
Uncomment scripts/ in .gitignore to allow versioning of the sync script. Add sync-docs-from-engine.mjs script to copy documentation sections from the engine repository to the docs site, preserving a legacy copy.
Instead of failing the workflow when documentation drift is detected, now show the diff statistics. This allows for easier identification of what changed without blocking the build.
Add exclusion list to sync script to prevent copying README.md, CHANGELOG.md, LICENSE, asset directories, and VitePress config files during documentation synchronization. This ensures only actual documentation content is synced between the engine and samples repository.
Remove the cloned engine directory after syncing documentation to prevent accumulation of unnecessary files in the workflow runner. Also exclude the .github directory from being copied during the sync to avoid overwriting workflow files.
- Correct API documentation links from `/api/graphics` to specific endpoints (`/api/graphics/sprite`, `/api/graphics/color`) - Update example project links to point to correct README files instead of `/examples/demos` - Fix library version reference in getting-started guide from `@^latest` to `@^1.2.1` - Add new API paths to VitePress ignoreDeadLinks configuration to prevent build warnings - Update changelog and other relative paths to use correct relative navigation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.