Conversation
This commit introduces a complete documentation system for the project using mdBook. Includes English and Chinese translations, custom Catppuccin theme, build scripts, and GitHub Actions workflow for automated deployment.
- Add flexible path detection for book output directories - Check both book/ and docs/book/ locations - Add error handling for missing build outputs - Improve debugging with directory listing
Refactor Chinese documentation to enforce consistent naming conventions: - Node names use PascalCase (e.g., OpeningScene, StartScene) - Function names use snake_case (e.g., play_sound, get_player_name) - Update all examples and code snippets across documentation files - Add naming convention guidelines and best practices
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.
PR Type
Please check the type of this PR (you can select multiple)
Related Issue
N/A - This is a new documentation system implementation
What does this PR do?
This PR introduces a comprehensive documentation system for the Mortar language using mdBook:
/en/) and Chinese (/zh-Hans/) with intelligent language detection and redirectionserve-en.sh,serve-zh.sh,build-docs.sh) for local development.gitignorefor mdBook artifacts and temporary filesHow to test?
Local Testing
Build Documentation Locally:
Preview English Documentation:
./serve-en.sh # Opens http://localhost:3000 with English docsPreview Chinese Documentation:
./serve-zh.sh # Opens http://localhost:3001 with Chinese docsVerify Theme Functionality:
GitHub Actions Testing
https://bli-aik.github.io/mortar/en/https://bli-aik.github.io/mortar/zh-Hans/https://bli-aik.github.io/mortar/(auto-detects language)Screenshots or Videos
N/A
Additional Information
Technical Implementation Details
N/A