Getting Started
Welcome to the GFX906 Wiki! This guide will help you set up the project locally and start exploring the documentation.
Prerequisites
- Git β to clone the repository.
- Rust (stable) β required for building
mdbook. - mdBook β can be installed via
cargo install mdbook(the GitHub Actions workflow does this automatically).
Clone the Repository
git clone https://github.com/yourusername/wiki-gfx906.git
cd wiki-gfx906
Build the Book Locally
-
Install
mdbookif you haven't already:cargo install mdbook -
Build the book:
mdbook buildThe generated static site will appear in
book/. -
Preview it locally:
mdbook serveOpen
http://localhost:3000in your browser to view the wiki.
Adding New Content
-
Create a new markdown file in
src/, e.g.:touch src/new_section.md -
Edit
src/SUMMARY.mdto include the new file:- [New Section](./new_section.md) -
Reβrun
mdbook buildormdbook serveto see your changes.
Contributing
- Fork the repository.
- Create a feature branch.
- Commit your changes with clear messages.
- Open a Pull Request targeting
main.
All contributions are welcome! See the Contributing page for detailed guidelines.
Deploy to GitHub Pages
The repository includes a GitHub Actions workflow (.github/workflows/mdbook.yml) that automatically builds the book and publishes it to GitHub Pages on every push to main. No manual steps are required.
Happy documenting! π