Skip to content

Weaving for edit on github button #140

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

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

Conversation

Jay-sanjay
Copy link

@Jay-sanjay Jay-sanjay commented Jan 16, 2024

  • Wait for the workflow, look at the preview, and confirm:
    • The preview has your tutorial listed.
    • The preview looks like what you want.

This PR is related to - JuliaSmoothOptimizers/JuliaSmoothOptimizers.github.io#83

Copy link
Member

@abelsiqueira abelsiqueira left a comment

Choose a reason for hiding this comment

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

Thanks for the PR, @Jay-sanjay. I made a change request to make it more efficient.
The preview won't work from this branch. Have you tested it? Do you have a preview built from your fork, maybe?

write(tutorial_path, tutorial_content * footer)

# Weave the tutorial
weave(tutorial_path)
Copy link
Member

Choose a reason for hiding this comment

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

The tutorial is already woven when weave_folder is called above, so this is weaving twice, which is slow.
Instead, this footer can be added in weave_file. The original code came from SciML tutorials, and I think that is how they do it there.

Copy link
Member

Choose a reason for hiding this comment

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

@Jay-sanjay, you marked this as resolved and re-requested a review. This is not resolved. Also, as you mentioned in your comment, the .md file doesn't have the "Edit this on Github", so your solution is apparently not working.
Let me know if you need some clarification, thanks.

@Jay-sanjay
Copy link
Author

Yes @abelsiqueira sir I did tried to build it as mentioned in the README using JSOTutorials.weave_file("create-a-manual-model", "index.jmd") but the .md file doesn't have that Edit this on Github thing added

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants