Skip to content

Rewrite documentation and publish it to github-pages using mkdocs #168

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

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

Lee-W
Copy link
Member

@Lee-W Lee-W commented Jun 27, 2025

Types of changes

  • Other (please describe)
    • documentation and CI

Description

  • ci(makefile): add build-docs and serve-docs targets to the makefile
  • docs: remove manually built table of contents
  • ci(github-actions): add doc publish action
  • docs: rewrite documentation, fix typos, and introduce spell-check to avoid typos

Checklist

  • Add test cases to all the changes you introduce
  • Run make lint and make test locally to ensure all linter checks and testing pass
  • Update the documentation if necessary

Steps to Test This Pull Request

Expected behavior

Related Issue

Additional context

Uploading image.png…

@Lee-W Lee-W changed the title Doc improvment Rewrite documentation and publish it to github-pages using mkdocs Jun 28, 2025
@Lee-W Lee-W marked this pull request as ready for review June 28, 2025 11:00
@Lee-W Lee-W requested a review from henry410213028 June 28, 2025 11:02
@Lee-W Lee-W force-pushed the doc-improvment branch from 26b7e6d to 745d95a Compare July 6, 2025 02:15
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.

1 participant