Skip to content

Commit

Permalink
update _config.yml, some api adjustments, etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
WindowsMeosu authored Oct 19, 2023
1 parent a801f33 commit 3a4017e
Show file tree
Hide file tree
Showing 9 changed files with 98 additions and 5 deletions.
8 changes: 7 additions & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,10 @@ categories: user, content, events, users, maps
output: true
paginate: 5
site_root: ./docs

footer_content: peppypedia, started by Windows Me (windowsmeosu on github) documents top osu! players, in-game features, etc. peppypedia is not a replacement for the osu!wiki. (remote theme- [Just-The-Docs](https://github.com/just-the-docs/just-the-docs/))
copyright: MiloTilo Services
gh_edit_link: true
gh_edit_link_text: "Edit or add improvisations to this page on GitHub."
gh_edit_repository: "https://github.com/windowsmeosu/peppypedia"
gh_edit_branch: "70-peppypedia-todo-checklist"
gh_edit_view_mode: "edit"
1 change: 0 additions & 1 deletion docs/api/404.json

This file was deleted.

2 changes: 1 addition & 1 deletion docs/api/Akolibed.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"exists":"true","name":"Akolibed","markup":"html/markdown","author":"Windows_Me"}
{"exists":"true","name":"Akolibed","markup":"html/markdown","author":"none","page creator":"Windows_Me"}
21 changes: 21 additions & 0 deletions docs/api/api.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// values lower than 70.00% typically do not meet peppypedia's standards.
{"peppy","progress";"60.02%"} // html-based, should rework
{"disco_prince","progress";"72.05%"}
{"Zallius","progress";"95.20%"}
{"jhlee0133","progress";"92.01%"}
{"WhiteCat","progress";"89.22%"}
{"Bancho","progress";"87.22%"}
{"IRC","progress";"96.99%"}
{"index","progress";"99.92%"}
{"COE","progress";"86.12%"}
{"users","progress";"0.00%"}
{"medals","progress";"0.01%"}
{"mrekk","progress";"97.56%"}
{"Akolibed","progress";"0.00%"}







1 change: 1 addition & 0 deletions docs/api/catschema.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"catschema";"alpha","version";"0.1","progress";"0.2%"}
64 changes: 64 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: API docs
layout: minimal
---

<title peppypedia API></title>

<center><h1>peppypedia API</h1></center>

peppypedia API documention\
Notes: `page creator` value exists only when the `author` value is set to `none` or `unknown`. Please state an username on the pull request body. An exception to this is if the following is already added before the metadata:
```md
<t><center>[Your username, do not remove brackets](https://osu.ppy.sh/users/0)</center>
<link rel="stylesheet" href="../profile.css"></t>

![Your username, do not remove brackets](https://a.ppy.sh/0.jpeg#author "Your username")
```

Should we fail to verify that the user profile linked belongs to you, a direct message will be sent to the user in question. If chat message are set to friends-only, we ask that you temporary allow direct messages from anyone, or direct message [Windows Me](<https://osu.ppy.sh/users/28893698>) yourself.

If the page is a documention page or a parent page, author values aren't required (and should not be added for the former). Should a page be entirely rewritten, the author value will change.

<center><h2>Users</h2></center>

if `exists` is set to value `true`, this indicates that the endpoint exists. markup value should always be `html/markdown`. `group` can be have multiple values:

```json
"group":"ppy" = peppy
"group":"SPT" = Support Team
"group":"Support Team" = Support Team
"group":"GMT" = Global Moderation Team
"group":"Global Moderation Team" = Global Moderaton Team
"group":"NAT" = Nomination Assessment Team
"group":"Nomination Assessment Team" = Nomination Assessment Team
(note: "mode" + gamemode should be inputted after if the group is set to BN, TrialBN, NAT, or BSC)
"group":"TrialBN" = Trial Beatmap Nominator
"group":"Trial Beatmap Nominator" = Trial Beatmap Nomnator
(note: "mode" + gamemode should be inputted after if the group is set to BN, TrialBN, NAT, or BSC)
"group":"BN" = Beatmap Nominator
"group":"Beatmap Nominator" = Beatmap Nominator
(note: "mode" + gamemode should be inputted after if the group is set to BN, TrialBN, NAT, or BSC)
"group":"DEV" = Developer
"group":"Developer" = Developer
"group":"BSC" = Beatmap Spotlight Curators
"group":"Beatmap Spotlight Curators" = Beatmap Spotlight Curators
(note: "mode" + gamemode should be inputted after if the group is set to BN, TrialBN, NAT, or BSC)



```sh
curl --request GET \
--get "https://milotilo.ddns.net/peppypedia/api/peppy.json" \
--header "Content-Type: application/XML" \
--header "Accept: application/XML"
```

response:

```json
{"exists":"true","name":"peppy","markup":"html/markdown","group":"ppy","author":"Windows_Me"}
```

API progress can be seen [here](index.ts).\
page completion progress can be seen [here](api.ts)
2 changes: 2 additions & 0 deletions docs/api/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{"api";"catschema";"lang";"XML/JSON"}
{"progress","users";"2.5%","beatmaps";"0.00%","medals","0.01%","TOCS";"92.00%","Bancho";"2.1%"}
2 changes: 1 addition & 1 deletion docs/content/en/users/Akolibed.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ peppypedia-current: [true]
nav_exclude: true
---

<t><center>[Unknown](https://osu.ppy.sh/users/28893698)</center>
<t><center>[Unknown](https://osu.ppy.sh/users/0)</center>
<link rel="stylesheet" href="../profile.css"></t>

![Unknown](https://a.ppy.sh/0.jpeg#author "No author")
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/users/jhlee0133.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ South Korea</th></tr></tbody></table>

[^better&#160;sources&#160;needed]: [Reddit | r/osugame: jhlee0l33 is now #1 in osu!mania ranking, taking over jhlee0133!](<https://www.reddit.com/r/osugame/comments/62r7vh/jhlee0l33_is_now_1_in_osumania_ranking_taking/>).

[^2]: [osu! | jhlee0133](<https://osu.ppy.sh/users/140148>).
[^2]: [osu! | jhlee0133](<https://osu.ppy.sh/users/140148>).

0 comments on commit 3a4017e

Please sign in to comment.