Skip to content

Documentation #2

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.

Sign up for GitHub

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

Jump to bottom
Merged
yhteoh merged 5 commits into from
Mar 3, 2025
Merged

Documentation #2

yhteoh merged 5 commits into from
Mar 3, 2025

Conversation

@yhteoh
Copy link
Contributor

@yhteoh yhteoh commented Mar 2, 2025 •
edited
Loading

  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines

  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    docs update

  • What is the current behavior? (You can also link to an open issue here)
    Nil

  • What is the new behavior (if this is a feature change)?

  • Added search to mkdocs documentation
  • Formatted example jupyter notebooks and other documents
  • Fix python version requirement
  • Fix dependencies
  • Added github action to test mkdocs build
  • Update deploy github action with uv

  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
    No

  • Other information:

@yhteoh yhteoh added the documentation Improvements or additions to documentation label Mar 2, 2025
@yhteoh yhteoh self-assigned this Mar 2, 2025
@yhteoh yhteoh requested a review from benjimaclellan March 2, 2025 17:13
@yhteoh yhteoh force-pushed the documentation branch 4 times, most recently from 7caf3c7 to 883f7d9 Compare March 2, 2025 17:43
benjimaclellan
benjimaclellan approved these changes Mar 3, 2025
View reviewed changes
Copy link
Member

@benjimaclellan benjimaclellan left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Should we add trical docs here? Or make a new PR later?

@yhteoh
Copy link
Contributor Author

yhteoh commented Mar 3, 2025

Should we add trical docs here? Or make a new PR later?

We will make another PR later.

@yhteoh yhteoh merged commit e3c9ba1 into main Mar 3, 2025
1 check passed
@yhteoh yhteoh deleted the documentation branch March 3, 2025 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@benjimaclellan benjimaclellan benjimaclellan approved these changes

Assignees

@yhteoh yhteoh

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@yhteoh @benjimaclellan