The Community Guide to Open-Source AI Software Craft

oss-ai-swe.org

Welcome to the Community Guide to Open-Source AI Software Craft! This project is a collaborative, open-source guide and knowledge base for software engineers working with open-source AI tools and workflows. Our goal is to help the community share best practices, tools, and insights for building, maintaining, and contributing to open-source AI software tools.

---

🌐 About the Website

This website is built using MkDocs and is designed to be easy to read, search, and contribute to. It serves as a living document for:

• Guides and tutorials for open-source AI development
• Tool and library overviews
• Best practices and workflows
• Community-contributed tips and resources

You can browse the site online or build it locally to preview your changes.

---

🚀 How It Works

The site is powered by MkDocs, a static site generator for project documentation. All content lives in the docs/ directory as Markdown files. The navigation and site configuration are managed in mkdocs.yml.

Key files and folders:

• docs/ — All documentation content (Markdown files)
• mkdocs.yml — Site configuration and navigation
• stylesheets/extra.css — Custom styles

To view the site locally:

pip install mkdocs
mkdocs serve

Then open http://localhost:8000 in your browser.

---

🛠️ How to Update the Website

1. Edit or add Markdown files in the docs/ directory. Each file becomes a page on the site.
2. Update mkdocs.yml to add new pages to the navigation.
3. Preview locally with mkdocs serve.
4. Commit your changes and open a pull request (see below).

---

🤝 Contributing

We welcome contributions from everyone! Whether you want to fix a typo, add a new guide, or suggest improvements, your help is appreciated.

How to Contribute

1. Check open issues or open a new one to discuss your idea.
2. Fork the repository and create a new branch for your changes.
3. Make your edits (see above for how to update the site).
4. Open a pull request with a clear description of your changes.
5. Participate in code review and update your PR as needed.

---

📬 Questions & Feedback

If you have questions, suggestions, or want to get involved, please open an issue or join the discussion on GitHub.

Thank you for helping make open-source AI software better for everyone!