📘 Winfig Docs

This repository contains the official documentation for the Get-Winfig organization a modular toolkit for automating Windows installation, configuration, and developer environment setup.

---

🧩 About

The documentation is built using MkDocs and published to GitHub Pages on Winfig-Docs.

All project guides, setup instructions, and usage references for Winfig modules (Setup, VS Code, WSL, Terminal, etc.) will be maintained here.

---

🛠️ Development

To run the documentation site locally:

Clone the repository

git clone https://github.com/Get-Winfig/winfig-docs.git

Change directory:

cd winfig-docs

Then install the required dependencies and serve the site:

uv sync

Serve locally

mkdocs serve

To build the static site:

mkdocs build

The site will be available at http://127.0.0.1:8000 in your browser.

---

🤝 Contribution

We welcome contributions to the Winfig documentation! If you have suggestions for improvements or want to add new content, please follow these steps:

1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes and commit them with clear messages.
4. Push your changes to your forked repository.
5. Create a pull request describing your changes.

Thank you for helping us improve the Winfig documentation!

---

📄 License

This documentation is licensed under the MIT License. See the LICENSE file for more information.