Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/contributing/contribution-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@ The website that you are looking at. We made the Atlas documentation in [MkDocs

See the [documentation contribution guide](documentation.md) on how to get started.

### Atlas Toolbox

[:simple-github: GitHub Repository](https://github.com/Atlas-OS/toolbox){ .md-button }
[:material-license: License (GPLv3)](https://github.com/Atlas-OS/toolbox/blob/main/LICENSE){ .md-button }
[:material-tag: Releases](https://github.com/Atlas-OS/astlas-toolbox/releases){ .md-button }

This repository contains the Atlas Toolbox's central source code, which is eventually published in a .msi installer.

See the [AtlasOS Toolbox contribution guide](toolbox.md) on how to get started.
## :octicons-issue-closed-24: How our GitHub Issues work

For transparency with users, we keep issues that affect the current release open and label them with the **fixed next release**.
Expand Down
32 changes: 32 additions & 0 deletions docs/contributing/toolbox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
description: How to contribute to the AtlasOS Toolbox
icon: material/toolbox
---

# :material-toolbox: Contributing to the Atlas Toolbox

This page will cover how to modify, test, and build Atlas. If you plan to contribute, we recommend reading the [Contribution Guidelines](contribution-guidelines.md) first!

We presume you've already cloned the [`Atlas-OS/atlas-toolbox`](https://github.com/Atlas-OS/atlas-toolbox) repository.

--8<-- "contribution-guidelines.md:gitNotice"

### What Atlas uses internally

The AtlasOS Toolbox primarily uses the following two languages:

1. [C# (.NET 8.0)](https://learn.microsoft.com/en-us/dotnet/csharp/tour-of-csharp/)
1. [XAML](https://learn.microsoft.com/en-us/dotnet/desktop/wpf/xaml/?view=netdesktop-9.0)

For development tools and resources, we recommend using:

- [Visual Studio Community 2022](https://visualstudio.microsoft.com/vs/)
- The Toolbox repo contains the default NuGet packages required.
- [.Net 8 Runtime](https://download.visualstudio.microsoft.com/download/pr/fc8c9dea-8180-4dad-bf1b-5f229cf47477/c3f0536639ab40f1470b6bad5e1b95b8/windowsdesktop-runtime-8.0.13-win-x64.exe) - Includeded in AtlasOS v0.5.0+
- [Windows App SDK 1.6](https://download.microsoft.com/download/7a3a6a44-b07e-4ca5-8b63-2de185769dbc/WindowsAppRuntimeInstall-x64.exe) - Includeded in AtlasOS v0.5.0+

For demos of UI elements used in the Toolbox, we recommend using:

- [WinUI 3 Gallery](https://apps.microsoft.com/detail/9p3jfpwwdzrc)
- [Windows Community Toolkit Gallery](https://apps.microsoft.com/detail/9nblggh4tlcq)

1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ nav:
- Contribution Guidelines: contributing/contribution-guidelines.md
- Documentation: contributing/documentation.md
- Playbook: contributing/playbook.md
- Toolbox: contributing/toolbox.md

- Testing:
- What to test: contributing/testing/what-to-test.md
Expand Down