Skip to content
This repository was archived by the owner on Jan 11, 2025. It is now read-only.

Refactor API documentation and release to Docusaurus #4

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

genesis-writing
Copy link

The current landing page was generated by Swagger API, but it had several limitations:

  • Low customizability, requiring hard coding for adjustments.
  • Poor mobile-friendliness and unappealing design (low priority).
  • Lacked versioning support for documentation.

Refactored Solution:

  • Migrated API documentation to Docusaurus using the docusaurus-plugin-openapi-docs plugin.
  • MDX Pages: Documentation is now dynamically built based on the openapi.yaml specification.
  • Versioning: The new setup supports versioning to keep documentation aligned with API versions.
  • Added a Project Contributors page to highlight team members involved in the project.
  • This change improves customization, adds documentation versioning, and makes the documentation more user-friendly.

@genesis-writing
Copy link
Author

Hi @KemingHe , hope you're having a great week. Here's the PR for Refactor(docs/), issue #1.

To test the changes locally, you can run pnpm run start. This will spin up the local development server so you can preview the changes before deployment. Let me know if anything needs tweaking!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant