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

add: jsdoc-api & vitepress for documentation generation #3032

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

qzdark
Copy link
Contributor

@qzdark qzdark commented May 14, 2024

PR Details

  • Generation via JSDoc API and VitePress instead of JSDoc itself
  • Addition of new/better comments for properties and methods
  • Fixed class & method tags

Description

Moving from JSDoc generation to beautiful VitePress generation.

Related Issue

Motivation and Context

Instead of outdated and eye-straining documentation that only works in white mode and looks like it's from the early 2000s, we are going to create beautiful documentation with VitePress and our own theme. This will facilitate better integration of new visual features within the documentation and improve user understanding and less created issues.

How Has This Been Tested

Work in progress...

Types of changes

  • Dependency change
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • I have updated the documentation accordingly (index.d.ts).

Moving from JSDoc generation to beautiful VitePress generation.
@alechkos alechkos added the breaking change Fix or feature that would cause existing functionality to change label May 14, 2024
@qzdark qzdark changed the title add: jsdoc-api & vitepress add: jsdoc-api & vitepress for documentation generation May 14, 2024
@alechkos alechkos added the dependencies Pull requests that update a dependency file label May 14, 2024
@alechkos alechkos requested review from pedroslopez and tuyuribr May 14, 2024 16:37
@qzdark
Copy link
Contributor Author

qzdark commented May 14, 2024

It will probably take some time until I have created the necessary elements for VitePress and the generation process works without any issues.

@alechkos
Copy link
Collaborator

@qzdark

It will probably take some time until I have created the necessary elements for VitePress and the generation process works without any issues.

Then I'll convert this PR as a draft. Feel free to convert it as ready for review once your are done.

@alechkos alechkos marked this pull request as draft May 16, 2024 03:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Fix or feature that would cause existing functionality to change dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants