-
Notifications
You must be signed in to change notification settings - Fork 69
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: rewritten README, contribution guide merged
- Loading branch information
Showing
8 changed files
with
30 additions
and
211 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,9 @@ | ||
### Type | ||
- [ ] Rewrite already written documentation. | ||
- [ ] Add/remove new pages. | ||
- [ ] Rewrite already written documentation | ||
- [ ] Add/remove new pages | ||
|
||
### Questions | ||
- [ ] Did you preview on your local machine beforehand? | ||
- [ ] Did you follow our [commit handbook](https://github.com/Atlas-OS/docs/blob/master/.github/CONTRIBUTING.md#commit-message)? | ||
- [ ] Did you preview your changes beforehand? | ||
- [ ] Did you read the [Atlas Contribution Guidelines](https://docs.atlasos.net/contributions/)? | ||
- [ ] Did you commit to the `dev` branch and not `master`? | ||
|
||
### Describe your pull request |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
name: "Pull Request Labeler" | ||
|
||
on: | ||
- pull_request_target | ||
|
||
jobs: | ||
filter: | ||
permissions: | ||
contents: read | ||
pull-requests: write | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/labeler@v4 |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,22 @@ | ||
# AtlasOS Documentation | ||
|
||
Atlas documentation hosted on Cloudflare Pages using Material for MkDocs. | ||
<a href="https://github.com/Atlas-OS/.github/blob/main/profile/CODE_OF_CONDUCT.md"><img alt="Code of Conduct" src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?style=for-the-badge&color=1A91FF" /></a> | ||
|
||
Here you can help Atlas with documentation, for now we do not have translation capabilities but they will be added in the future. | ||
This repository contains the Atlas documentation hosted on Cloudflare Pages using Material for MkDocs. | ||
|
||
**Want to contribute?** Please check out our [Documentation Contribution Guidelines](.github/CONTRIBUTING.md) and the [Atlas Contribution Guidelines](https://docs.atlasos.net/contributions) for more information. | ||
**Want to contribute?** Please check out the [Atlas Contribution Guidelines](https://docs.atlasos.net/contributions) for more information. | ||
|
||
## How to make a preview build? | ||
## How do I contribute? | ||
|
||
As MkDocs uses Python, you will need to have Python and pip installed, we recommend using [Scoop](https://scoop.sh) or [Chocolatey](https://chocolatey.org) to install these but you can also install via [Python's website](https://www.python.org). | ||
As MkDocs Material uses Python, you must install [Python](https://www.python.org/downloads/) alongside `pip` before continuing. | ||
|
||
Material for MkDocs has already made a page, which you can use for [Installation of Material for MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started). | ||
1. Once you've cloned the repository, `cd` into it using a shell | ||
1. Run `pip install -r requirements.txt` to install all the dependencies | ||
1. If you're on Windows, run `locally-host.cmd` to host the documentation preview | ||
- If you're on another OS, just run `mkdocs serve` | ||
- The `locally-host.cmd` script is only for convenience | ||
|
||
Depending if you installed it locally or via a virtual envioronment, there is already a [guide on previewing](https://squidfunk.github.io/mkdocs-material/creating-your-site/#previewing-as-you-write) | ||
You can now make all your changes and view them live! | ||
|
||
## Credit | ||
## Credits | ||
- [Hummingbot documentation](https://github.com/hummingbot/hummingbot) for many aspects of the documentation theming, such as the blurred header |
This file contains 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