Skip to content

Commit 9eb2013

Browse files
Witty-WizardWitty-Wizard
authored
updated READMEadded automations
1 parent d02b45e commit 9eb2013

File tree

7 files changed

+133
-30
lines changed

7 files changed

+133
-30
lines changed

‎.github/CODEOWNERS

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Define code ownership for the entire repository
2+
* @Witty-Wizard

‎.github/ISSUE_TEMPLATE/bug_report.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: 🪲 Bug Report
3+
about: Create a bug report to help us resolving the bug
4+
title: '🪲[Bug]: '
5+
labels: '🪲bug'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/docs.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: 📝 Documentation
3+
about: Propose changes and improvements to Cansat-Ground-Station Docs.
4+
title: '📝[Docs]: '
5+
labels: '📝docs'
6+
assignees: ''
7+
---
8+
9+
**What Docs changes are you proposing?**
10+
Provide a clear description of the changes you're proposing for the documentation. Are you suggesting corrections, clarifications, additions, or updates?
11+
12+
**Why do the Docs need this improvement? What is the motivation for this change? How will this change benefit the community?**
13+
Explain the motivation behind the proposed changes and how they will benefit the community or users of the documentation.
14+
15+
**Describe the solution you'd like**
16+
Provide a clear and concise description of the changes you'd like to see implemented in the documentation.
17+
18+
**Describe alternatives you've considered**
19+
If you've thought about alternative approaches or solutions, briefly describe them here.
20+
21+
**Additional context**
22+
Add any additional context, examples, or screenshots related to the proposed documentation changes.

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: ✨ Feature Request
3+
about: ✨Suggest an interesting feature idea for this project
4+
title: '✨[FEATURE]: '
5+
labels: '✨enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/workflows/doxygen.yaml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Doxygen Action
2+
3+
on:
4+
push:
5+
tags:
6+
- '*'
7+
branches:
8+
- main
9+
10+
jobs:
11+
build:
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- uses: actions/checkout@v4
16+
17+
- name: Download Custom CSS File
18+
run: curl -o doxygen-awesome.css https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/main/doxygen-awesome.css
19+
20+
- name: Doxygen Action
21+
uses: mattnotmitt/[email protected]
22+
with:
23+
doxyfile-path: "./Doxyfile"
24+
working-directory: "."
25+
26+
- name: Upload Documentation as Artifact
27+
uses: actions/upload-artifact@v4
28+
with:
29+
name: documentation
30+
path: ./Docs/html
31+
32+
deploy:
33+
runs-on: ubuntu-latest
34+
needs: build
35+
if: startsWith(github.ref, 'refs/tags/v')
36+
37+
steps:
38+
- uses: actions/checkout@v4
39+
40+
- name: Download Documentation Artifact
41+
uses: actions/download-artifact@v4
42+
with:
43+
name: documentation
44+
path: ./Docs/html
45+
46+
- name: Deploy
47+
uses: peaceiris/actions-gh-pages@v4
48+
with:
49+
github_token: ${{ secrets.GH_PAGES_TOKEN }}
50+
publish_dir: ./Docs/html

‎.github/workflows/main.yaml

-29
This file was deleted.

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<p align="center">
22
<a href="https://github.com/Witty-Wizard/DriveMaster/releases"><img src="https://img.shields.io/github/v/release/Witty-Wizard/DriveMaster" alt="GitHub Release"></a>
33
<a href="https://github.com/Witty-Wizard/DriveMaster/actions/workflows/arduinio_ci.yaml"><img src="https://github.com/Witty-Wizard/DriveMaster/actions/workflows/arduinio_ci.yaml/badge.svg" alt="Arduino_CI"></a>
4-
<a href="https://github.com/Witty-Wizard/DriveMaster/actions/workflows/main.yaml"><img src="https://github.com/Witty-Wizard/DriveMaster/actions/workflows/main.yaml/badge.svg" alt="Doxygen CI"></a>
4+
<a href="https://github.com/Witty-Wizard/DriveMaster/actions/workflows/doxygen.yaml"><img src="https://github.com/Witty-Wizard/DriveMaster/actions/workflows/doxygen.yaml/badge.svg" alt="Doxygen CI"></a>
55
<a href="https://witty-wizard.github.io/DriveMaster/"><img src="https://img.shields.io/badge/-Doxygen-2C4AA8?style=flat&logo=doxygen&logoColor=white" alt="Doxygen"></a>
66
<a href="https://www.gnu.org/licenses/gpl-3.0.html"><img src="https://img.shields.io/github/license/Witty-Wizard/DriveMaster" alt="GitHub License"></a>
77
</p>

0 commit comments

Comments
 (0)