Expand docs

[skysomorphic]

Closes #143 when completed

click for pr summary

[skysomorphic]

RFC on this new API main page design?
Each endpoint would have its own page that can be accessed from the sidebar or clicking any of the description headings.

The actual docs of the endpoint is just a placeholder for now that I copied from the old page.

[geoffrey-wu]

Looks perfect to me!

[skysomorphic]

quick question: is it stylized "QBReader", "QB Reader", "qbreader", or whatever else lol

[geoffrey-wu]

quick question: is it stylized "QBReader", "QB Reader", "qbreader", or whatever else lol

I would go for QB Reader, but in honesty I'm not sure if anyone knows.

[geoffrey-wu]

Any idea on when this will be completed? It looks very exciting 👀

[skysomorphic]

got caught up in school will probably be done later this week!

[skysomorphic]

I've gone back and checked out the up to date scss files and integrated any additions to the docs in main. It should be ok to override conflicting files with changes in this pr.

[skysomorphic]

I didn't include URL examples for requests, because I feel like that sort of thing can be easily done with tools like HTTPie, especially their web app. I'll definitely consider adding things like cookbooks and quickstarts if the API gets large enough though.

[skysomorphic]

Summary

Changes

• Revamped API documentation with seperate pages for each endpoint, schema specs, and detailed typing information
• Sidebar to traverse docs (I made it responsively disappear on small enough windows but I haven't tested it on mobile)
• /api-info is now /api-docs, requests will be redirected to not break hyperlinks
• Added JSON schemas in server/schemas.js, they kinda just vibin there rn not really sure how they'll be implemented

Notes and ideas for the future

• Some of the endpoints return full objects while others only return arrays. I think it might be worth converting one that don't return objects (like api/check-answer) into returning objects for consistency and easier use for developers.
• Many questions in the database are missing certian fields in the schema like formatted_answer, could definitely be a problem for devs expecting all fields to be complete.
• Quickstarts and cookbooks
• probably should change api/random-question to GET soon
• accordion design???