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

[ECO-798] Add quick fix for redocusaurus issue #561

Merged
merged 1 commit into from
Oct 24, 2023
Merged

[ECO-798] Add quick fix for redocusaurus issue #561

merged 1 commit into from
Oct 24, 2023

Conversation

alnoki
Copy link
Member

@alnoki alnoki commented Oct 24, 2023

Background

The docs site build started failing, apparently due to an issue with the redocusaurus Open API plugin.

After some searching I found an issue that appears related, with a comment flagging how failed builds were a result of people using the redoc/open API plugin: facebook/docusaurus#7398 (comment)

The following comment states how on one day a build passed, then the next day it failed. Similar behavior recently affected the Econia docs site build.

Perfect support for the REST API documentation is not a priority at present, but the docs site does need to be able to be updated.

Changes

  • Disable redocusaurus plugin
  • Add message to REST API page about plugin issues

Verification

From within /doc/doc-site/ I was able to run pnpm build without failure, then pnpm start functioned as expected.

@alnoki alnoki requested a review from elliottdehn October 24, 2023 00:04
@CRBl69 CRBl69 merged commit 538f8ef into main Oct 24, 2023
@CRBl69 CRBl69 deleted the ECO-798 branch October 24, 2023 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants