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

DOC: replace Beginners Guide pluto notebook with simple markdown html. #20

Merged
merged 2 commits into from
Nov 28, 2023

Conversation

juanjospina
Copy link
Collaborator

Pull Request (PR) Template

This PR replaces the currently used BeginnersGuide.jl Pluto notebook with a simple HTML file (with markdown) that presents the Beginner guide in a more concise and simple way.

This PR is needed due to the error that exists when running PowerModelsITD using Pluto notebooks. There is a compatibility error inherited from PowerModels, and that is related to the Memento logger, that causes a stream error in Pluto Notebooks, making it impossible to run PowerModelsITD code in a Pluto notebook. So, to avoid confusing the user (beginner), we removed the need to use a Pluto notebook to follow the Beginner's guide.

This PR removes Gumbo and Pluto dependencies previously needed to create the DOCs of the project.

@juanjospina juanjospina added the documentation Improvements or additions to documentation label Nov 27, 2023
Copy link

codecov bot commented Nov 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (76ad53e) 80.57% compared to head (93877e9) 80.57%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #20   +/-   ##
=======================================
  Coverage   80.57%   80.57%           
=======================================
  Files          30       30           
  Lines        4885     4885           
=======================================
  Hits         3936     3936           
  Misses        949      949           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@juanjospina juanjospina merged commit e0c66c3 into lanl-ansi:main Nov 28, 2023
12 checks passed
@juanjospina juanjospina deleted the fixBeginnersGuide branch November 28, 2023 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant