Skip to content

Commit ec2c2b7

Browse files
LucJosinLucJosin
authored
Feat: Pages (#8)
### Features - Add `/support` page. - Add `package.json` with [Scripts](#scripts) - Add `/scripts` to build, clean, get-sdks and watch (retype) - Re-add `/SDK's` page with "dynamic" files. ### Changes - Update gitignore - Update links
1 parent df9eb69 commit ec2c2b7

14 files changed

Lines changed: 237 additions & 30 deletions

File tree

‎.gitignore‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# Build files
22

3-
/build/
3+
/build/
4+
.downloads/
5+
tmp/
6+
7+
SDK's/*
8+
!SDK's/index.md
9+
!SDK's/index.yaml

‎About.md‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,7 @@ order: -1
55

66
# About
77

8-
Technical support questions are best asked in the [Discussion](https://github.com/HawAPI/api/discussions) forum.
9-
10-
Did you find a bug? Please create an [Issue](https://github.com/HawAPI/api/issues).
11-
12-
Do you have a general inquiry? Please feel free to contact at hawapi@lucasjosino.com.
8+
Technical support questions check [Support](./Support.md).
139

1410
## Maintainers
1511

@@ -56,7 +52,7 @@ All licenses of the project, including third party **packages/libraries/dependen
5652

5753
### Project license
5854

59-
> **HawAPI** is licensed under the [MIT License](https://github.com/HawAPI/api/LICENSE).
55+
> **HawAPI** is licensed under the [MIT License](https://github.com/HawAPI/HawAPI/LICENSE).
6056
6157
```
6258
MIT License

‎FAQ.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ order: 1
55

66
# FAQ
77

8-
Technical support questions are best asked in the [Discussion](https://github.com/HawAPI/api/discussions) forum.
8+
Technical support questions are best asked in the [Discussion](https://github.com/HawAPI/feedback/discussions) forum.
99

1010
==- It's a free API?
1111
Yes, free and open source.
@@ -22,7 +22,7 @@ See more: [!ref Rate Limiting](./Guides/Rate-Limiting.md)
2222
==- What endpoint do I use to DELETE/UPDATE/POST data?
2323
This API is **read-only** so, there is no data manipulation endpoint.
2424

25-
If you found some wrong information. Please [informe us](https://github.com/HawAPI/).
25+
If you found some wrong information. Please [informe us](https://github.com/HawAPI/api-data/issues).
2626
==- Where can I get more help?
2727
Check out the [about page](About.md)
2828
==-

‎README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,10 @@ All this information is available through a RESTful API implemented with _Java (
2424
- [Seasons](./API/Seasons.md)
2525
- [Soundtracks](./API/Soundtracks.md)
2626
- [SDK's](./SDK's/)
27-
- [JavaScript](./SDK's/JavaScript.md)
28-
- [Java](./SDK's/Java.md)
27+
- [JavaScript](./SDK's/java-sdk.md)
28+
- [Java](./SDK's/js-sdk.md)
2929
- [FAQ](./FAQ.md)
30+
- [Support](./Support.md)
3031
- [About](./About.md)
3132
- [Maintainers](./About.md#maintainers)
3233
- [What I Used?](./About.md#what-i-used)

‎SDK's.md‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎SDK's/index.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SDK's
2+
3+
| Language | Links | Project | Maintainer |
4+
| :--------- | :---------------------------------------------------------: | :----------------------: | :-------------------------------------: |
5+
| JavaScript | [:icon-file-code:](./js-sdk.md) - [:icon-mark-github:][1] | :icon-verified: Official | [LucJosin](https://github.com/LucJosin) |
6+
| Java | [:icon-file-code:](./java-sdk.md) - [:icon-mark-github:][2] | :icon-verified: Official | [LucJosin](https://github.com/LucJosin) |
7+
8+
[1]: https://github.com/HawAPI/js-sdk
9+
[2]: https://github.com/HawAPI/java-sdk

‎SDK's/index.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
icon: code
2+
order: 2

‎Support.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
icon: link
3+
---
4+
5+
# Support
6+
7+
For General/Technical support questions are best asked in the [Discussion](https://github.com/orgs/HawAPI/discussions) forum.
8+
9+
Do you have a general inquiry? Please feel free to contact at [hawapi@lucasjosino.com](mailto:hawapi@lucasjosino.com).
10+
11+
## Project
12+
13+
| Repository | Links | Support |
14+
| :--------- | :-------------------------------: | :-----------------------------------------: |
15+
| General | `---` | [:icon-mark-github:][1] - [:icon-mail:][8] |
16+
| Website | [`hawapi.theproject.id/`][5] | [:icon-mark-github:][2] - [:icon-mail:][9] |
17+
| API | [`hawapi.theproject.id/api/`][6] | [:icon-mark-github:][3] - [:icon-mail:][10] |
18+
| Docs | [`hawapi.theproject.id/docs/`][7] | [:icon-mark-github:][4] - [:icon-mail:][11] |
19+
20+
## SDK's
21+
22+
!!!info Info
23+
Check [SDK's](./SDK's/)
24+
!!!
25+
26+
[1]: https://github.com/HawAPI/feedback/issues
27+
[2]: https://github.com/HawAPI/website/issues
28+
[3]: https://github.com/HawAPI/HawAPI/issues
29+
[4]: https://github.com/HawAPI/docs/issues
30+
[5]: https://hawapi.theproject.id/
31+
[6]: https://hawapi.theproject.id/api/
32+
[7]: https://hawapi.theproject.id/docs/
33+
34+
[8]: mailto:hawapi@lucasjosino.com?subject=[General]
35+
[9]: mailto:hawapi@lucasjosino.com?subject=[Website]
36+
[10]: mailto:hawapi@lucasjosino.com?subject=[API]
37+
[11]: mailto:hawapi@lucasjosino.com?subject=[Docs]

‎package.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"scripts": {
3+
"build": "./scripts/build-docs.sh",
4+
"watch": "./scripts/watch-docs.sh",
5+
"get": "./scripts/get-sdks.sh",
6+
"clean": "./scripts/clean.sh"
7+
}
8+
}

‎retype.yml‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,9 @@ links:
2525
icon: mark-github
2626
target: blank
2727
- text: Discussions
28-
link: https://github.com/HawAPI/api/discussions
28+
link: https://github.com/HawAPI/feedback/discussions
2929
icon: comment-discussion
3030
target: blank
31-
- text: Issues
32-
link: https://github.com/HawAPI/api/issues
33-
icon: issue-opened
34-
target: blank
3531
footer:
3632
copyright: "© Copyright {{ year }}. All rights reserved."
3733
links:

0 commit comments

Comments
 (0)