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

docs: update quartodoc to include getting started and examples #110

Merged
merged 13 commits into from
Dec 6, 2024

Conversation

jooyoungseo
Copy link
Member

This pull request includes changes to add the quartodoc and extension structure, update the .gitignore file, and update the GitHub workflow to use the interlinks filter in quartodoc. These changes improve the organization and functionality of the project.

I am working on the getting started and example pages.

fixes #97

Copy link
Member Author

@jooyoungseo jooyoungseo left a comment

Choose a reason for hiding this comment

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

Tomorrow, I need to work on the following examples:

  • Jupyter Notebook (hosted somewhere like Posit Connect)

  • Google Colab example (and embed it via iframe)

  • Streamlit example (hosted somewhere like Posit Connect)

@jooyoungseo
Copy link
Member Author

I also need to take a quick tour video, demonstrating how to interact with py_maidr.

@jooyoungseo jooyoungseo marked this pull request as ready for review December 6, 2024 01:34
@jooyoungseo jooyoungseo merged commit a95ff96 into main Dec 6, 2024
9 checks passed
@jooyoungseo jooyoungseo deleted the jooyoungseo/issue97 branch December 6, 2024 01:34
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.

docs: add documentation for api reference, overview, and get started
1 participant