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

API document combined by @samchon/openapi #1494

Merged
merged 1 commit into from
Feb 8, 2025
Merged

API document combined by @samchon/openapi #1494

merged 1 commit into from
Feb 8, 2025

Conversation

samchon
Copy link
Owner

@samchon samchon commented Feb 8, 2025

This pull request includes several changes to improve the handling of TypeDoc JSON files and update the build process for the website. The most important changes include adding a new script to generate TypeDoc JSON files, updating the .gitignore file, and modifying the build script in package.json.

Improvements to TypeDoc JSON handling:

  • website/build/typedoc.js: Added a new script to generate TypeDoc JSON files, fetch OpenAPI JSON, and merge them using the TypeDoc GitHub theme.

Updates to build process:

  • website/package.json: Updated the build:typedoc script to use the new build/typedoc.js script instead of directly calling TypeDoc.

Updates to .gitignore:

  • website/.gitignore: Added typedoc-json/ to the .gitignore file to exclude generated TypeDoc JSON files from version control.

@samchon samchon added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 8, 2025
@samchon samchon self-assigned this Feb 8, 2025
Copy link
Owner Author

@samchon samchon left a comment

Choose a reason for hiding this comment

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

No problem.

@samchon samchon merged commit 3234984 into master Feb 8, 2025
3 checks passed
@samchon samchon deleted the doc/api branch February 8, 2025 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant