PokeAPI / pokeapi.co

The PokéAPI documentation website
https://pokeapi.co
BSD 3-Clause "New" or "Revised" License
136 stars 52 forks source link

Idea: Cosmetic Features #134

Closed ghost closed 1 year ago

ghost commented 1 year ago

I want to show some of my suggestions regarding this website. Here are the lists of ideas:

I shall contribute into this project if you think these ideas are relevant to the PokeAPI Community. I will then propose the new design of the website in this issue thread if i have no issue with time.

Naramsim commented 1 year ago

Hi @ricemashi, thanks a lot for the ideas. The 1st one is really needed.

the second one has to be thought out well. What would you allow to be searched?

The third might be the most needed one. Right now editing the website is a bit tedious because we have to write HTML. Having something that allows us to write in MD would be better.

ghost commented 1 year ago

What would you allow to be searched?

The api documentation specifically, each topic or sub-topic can be instantly navigated. I know you can search it via ctrl f, its just another cosmetic feature I have thought of.

Right now editing the website is a bit tedious because we have to write HTML. Having something that allows us to write in MD would be better.

Oh yea, I definetly agree with your statement. We could hydrate the website in MDX format if thats the hard case.

Naramsim commented 1 year ago

Yeah, the ctrl-f works ok right now. Up to you if you would like to work on it. I won't be able to follow along and review many PR. So you'll be primarily alone doing the work. I know it's not ideal but we lack people who have time to dedicate to the project, including myself as well now.

C-Garza commented 1 year ago

I can help review PR's and if you need any questions answered I can try and help out when I have time.

ghost commented 1 year ago

Yeah, the ctrl-f works ok right now. Up to you if you would like to work on it. I won't be able to follow along and review many PR. So you'll be primarily alone doing the work. I know it's not ideal but we lack people who have time to dedicate to the project, including myself as well now.

Same here, just ran across this API Documentation when I was teaching APIs to my brother. I just thought of an idea inspired from other API Documentations!

And yea, I would also definitely open a PR whenever im available. Thanks for the reply guys, I'll close this issue from now.