From 3a4017e900a7a4e3a234f346122a30d184d9d3e1 Mon Sep 17 00:00:00 2001 From: Milo <104236864+WindowsMeosu@users.noreply.github.com> Date: Fri, 20 Oct 2023 00:51:30 +0200 Subject: [PATCH] update `_config.yml`, some api adjustments, etc. --- docs/_config.yml | 8 +++- docs/api/404.json | 1 - docs/api/Akolibed.json | 2 +- docs/api/api.ts | 21 ++++++++++ docs/api/catschema.ts | 1 + docs/api/index.md | 64 ++++++++++++++++++++++++++++++ docs/api/index.ts | 2 + docs/content/en/users/Akolibed.md | 2 +- docs/content/en/users/jhlee0133.md | 2 +- 9 files changed, 98 insertions(+), 5 deletions(-) delete mode 100644 docs/api/404.json create mode 100644 docs/api/api.ts create mode 100644 docs/api/catschema.ts create mode 100644 docs/api/index.md create mode 100644 docs/api/index.ts diff --git a/docs/_config.yml b/docs/_config.yml index fe51b5f..0cd7719 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -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" \ No newline at end of file diff --git a/docs/api/404.json b/docs/api/404.json deleted file mode 100644 index bfdfb39..0000000 --- a/docs/api/404.json +++ /dev/null @@ -1 +0,0 @@ -{"exists":"false"} \ No newline at end of file diff --git a/docs/api/Akolibed.json b/docs/api/Akolibed.json index 14e1e84..d55ee71 100644 --- a/docs/api/Akolibed.json +++ b/docs/api/Akolibed.json @@ -1 +1 @@ -{"exists":"true","name":"Akolibed","markup":"html/markdown","author":"Windows_Me"} \ No newline at end of file +{"exists":"true","name":"Akolibed","markup":"html/markdown","author":"none","page creator":"Windows_Me"} \ No newline at end of file diff --git a/docs/api/api.ts b/docs/api/api.ts new file mode 100644 index 0000000..2106602 --- /dev/null +++ b/docs/api/api.ts @@ -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%"} + + + + + + + diff --git a/docs/api/catschema.ts b/docs/api/catschema.ts new file mode 100644 index 0000000..a52c7e1 --- /dev/null +++ b/docs/api/catschema.ts @@ -0,0 +1 @@ +{"catschema";"alpha","version";"0.1","progress";"0.2%"} \ No newline at end of file diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 0000000..0f2f311 --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,64 @@ +--- +title: API docs +layout: minimal +--- + + + +

peppypedia API

+ +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 +
[Your username, do not remove brackets](https://osu.ppy.sh/users/0)
+ + +![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]() 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. + +

Users

+ +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) \ No newline at end of file diff --git a/docs/api/index.ts b/docs/api/index.ts new file mode 100644 index 0000000..befb823 --- /dev/null +++ b/docs/api/index.ts @@ -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%"} \ No newline at end of file diff --git a/docs/content/en/users/Akolibed.md b/docs/content/en/users/Akolibed.md index 9598197..2df28b8 100644 --- a/docs/content/en/users/Akolibed.md +++ b/docs/content/en/users/Akolibed.md @@ -12,7 +12,7 @@ peppypedia-current: [true] nav_exclude: true --- -
[Unknown](https://osu.ppy.sh/users/28893698)
+
[Unknown](https://osu.ppy.sh/users/0)
 ![Unknown](https://a.ppy.sh/0.jpeg#author "No author") diff --git a/docs/content/en/users/jhlee0133.md b/docs/content/en/users/jhlee0133.md index 2f1bee2..4088f1f 100644 --- a/docs/content/en/users/jhlee0133.md +++ b/docs/content/en/users/jhlee0133.md @@ -44,4 +44,4 @@ South Korea [^better sources needed]: [Reddit | r/osugame: jhlee0l33 is now #1 in osu!mania ranking, taking over jhlee0133!](). -[^2]: [osu! | jhlee0133](). \ No newline at end of file +[^2]: [osu! | jhlee0133]().