Create mdbook documentation structure with GitHub Pages deployment#1
Merged
nikomatsakis merged 2 commits intomainfrom Sep 18, 2025
Merged
Conversation
…es deployment Co-authored-by: nikomatsakis <155238+nikomatsakis@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Can you create a basic mdbook structure with a MIT/APACHE-2.0 license? I'd like to have a github action that renders to github pages. The content should start with a simple outline
- Welcome
- Reference material
- Alice Ryhl's "Actors with Tokio" ...
Create mdbook documentation structure with GitHub Pages deployment
Sep 18, 2025
nikomatsakis
approved these changes
Sep 18, 2025
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
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.
This PR establishes a complete mdbook documentation structure for the Rust Philosopher project, transforming it from a simple README into a comprehensive documentation site with automated GitHub Pages deployment.
What's Added
📚 Documentation Structure
⚖️ Dual Licensing
Added both MIT and Apache 2.0 licenses as requested:
LICENSE-MIT- MIT LicenseLICENSE-APACHE- Apache 2.0 License🚀 GitHub Pages Automation
Created
.github/workflows/deploy.ymlthat:mainbranch⚙️ Configuration
book.tomlconfigured with repository metadata, GitHub integration, and edit links.gitignoreto exclude build artifactsTechnical Implementation
The mdbook structure follows best practices:
The Alice Ryhl article (385 lines) includes the complete content on building actors with Tokio, featuring:
Screenshots
The welcome page provides a clear introduction to the project's purpose and organization.
The Alice Ryhl article is beautifully rendered with proper code highlighting and navigation.
Ready for Production
The implementation is complete and tested:
Once merged, GitHub Pages will automatically deploy the documentation, providing a solid foundation for expanding the Rust best practices collection.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.