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

Documentation Site Rework #202

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

YetAnotherClown
Copy link
Contributor

@YetAnotherClown YetAnotherClown commented Feb 25, 2025

Brief Description of your Changes.

The purpose of this PR is to redesign the Documentation Site, which will include up-to-date information, helpful graphics, in-depth information and guides on the library, and to migrate the API to inline doc comments with Moonwave.

Impact of your Changes

  • Documentation Site Generator will be migrated to Docusaurus, so we may take advantage of the docusaurus-plugin-moonwave package for rendering our inline documentation
  • All public API in the source code will receive brief, but insightful doc comments above including classes, functions, and properties which are exported from the module
  • A complete revamp of all information on the site, a major redesign of the layout and aesthetic of the site, and new graphics will be made for the new site.

Tests Performed

Changes will not impact the stability nor performance of the project, changes include only added or modified comments in the source code.

When this PR is opened for review, a release build of the website will be deployed onto GitHub Pages. This will serve as a test to ensure the website builds correctly and renders appropriately.

Additional Comments

Resolves #50
Resolves #150

@YetAnotherClown
Copy link
Contributor Author

This is the latest preview of the redesigned homepage for the new site until a live preview of the website is available.

Jecs_Graphics

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.

Certain APIs missing from documentation Better documentation needed
1 participant