Skip to content

Commit

Permalink
feat: rewritten README, contribution guide merged
Browse files Browse the repository at this point in the history
  • Loading branch information
he3als committed Jun 5, 2024
1 parent ae0c44e commit 29ba9fc
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 211 deletions.
80 changes: 0 additions & 80 deletions .github/CODE_OF_CONDUCT.md

This file was deleted.

23 changes: 0 additions & 23 deletions .github/CONTRIBUTING.md

This file was deleted.

8 changes: 3 additions & 5 deletions .github/pull_request_template.md
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
40 changes: 0 additions & 40 deletions .github/workflows/dev-branch-merge.yaml

This file was deleted.

55 changes: 0 additions & 55 deletions .github/workflows/filter.yaml

This file was deleted.

13 changes: 13 additions & 0 deletions .github/workflows/labeler.yaml
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
20 changes: 12 additions & 8 deletions README.md
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
2 changes: 2 additions & 0 deletions docs/contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Atlas uses [:simple-github: GitHub](https://github.com/Atlas-OS) to manage every

## :octicons-git-commit-24: Areas of contribution

A [Code of Conduct](https://github.com/Atlas-OS/.github/blob/main/profile/CODE_OF_CONDUCT.md) applies to each Atlas repository. Please read this before contributing.

### Atlas Playbook

[:simple-github: GitHub Repository](https://github.com/Atlas-OS/Atlas){ .md-button }
Expand Down

0 comments on commit 29ba9fc

Please sign in to comment.