Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix API page #232

Closed
wants to merge 15 commits into from
Closed

Fix API page #232

wants to merge 15 commits into from

Conversation

UpcraftLP
Copy link
Contributor

@UpcraftLP UpcraftLP commented Jun 28, 2024

This PR fixes the api docs page by replacing the previous hackjob with a dedicated swagger-ui package built for astro.

Note

Custom CSS seems to be broken, but will have to be fixed at a later date.
Right now having a slightly-bad-looking API page is better than none at all.


See preview on Cloudflare Pages: https://preview-232.quiltmc-org.pages.dev

@UpcraftLP UpcraftLP marked this pull request as draft June 28, 2024 09:02
Copy link
Member

@Pyrofab Pyrofab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question : will this include the swagger JS on every page ? If so, how heavy is it ?

@UpcraftLP
Copy link
Contributor Author

Question : will this include the swagger JS on every page ? If so, how heavy is it ?

No, it will not.
It will only load that on the /api page

@ix0rai ix0rai added the bug Something isn't working label Jul 4, 2024
@Hex4dec
Copy link

Hex4dec commented Jul 23, 2024

Anything blocking this? This has been drafted for a month.

@ix0rai
Copy link
Member

ix0rai commented Jul 23, 2024

if you check the preview, you'll see that this PR completely breaks i18n

@Hex4dec
Copy link

Hex4dec commented Jul 23, 2024

I see. How has such an issue not been fixed in a month's time? Surely it should take at most a week.

@ix0rai
Copy link
Member

ix0rai commented Jul 23, 2024

quilt is all volunteer work, so we can't expect our contributors to always promptly fix issues. one good thing about open source is that someone else can always pick up the work!

@UpcraftLP
Copy link
Contributor Author

I see. How has such an issue not been fixed in a month's time? Surely it should take at most a week.

Surely it should also not be using an ancient version of astro and ancient versions of dependencies that break if you update, but here we are.

Feel free to check out the changes of this PR and fix the issues with it.

@Pyrofab Pyrofab mentioned this pull request Aug 8, 2024
@ix0rai ix0rai linked an issue Aug 8, 2024 that may be closed by this pull request
@Southpaw1496
Copy link
Contributor

The styling is a bit odd on dark mode, could that be changed?

Screenshot 2024-09-01 at 9 10 47 PM

@Southpaw1496
Copy link
Contributor

Ah, I see you've actually addressed the CSS in your original request

Question: The page on https://quiltmc.org/api/ is working fine for me, is there something I'm missing?

@ix0rai
Copy link
Member

ix0rai commented Sep 1, 2024

seems like the astro update may have fixed it!

@Southpaw1496
Copy link
Contributor

Well, brilliant!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API home is broken
5 participants