Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

should we still reference Perses in showcase notebook?

Open
#165 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
jupyter-notebook
Domain
documentation

Research direction

Open the showcase notebook and find the references describing behavior as “Perses-like.” Read the surrounding explanation and revise or remove those references so a new user is not distracted by Perses’s development status; done means the notebook’s wording is clear without that contextual confusion.

Written by the indexing model from the issue text.

Description

documentation

When I first ran the showcase notebook without any contextual knowledge, I was confused as to why behavior was described as "Perses-like", since the Perses homepage comes with a big "under development" disclaimer.

I now understand that OpenFE borrowed from Perses, but for a new user I think this is more distracting than it is helpful. I suggest we rephrase or remove these references for the sake of clarity.

Dominant language
Jupyter Notebook
Stars
70
Forks
15
Avg merge
4d 11h
Merged PRs (30d)
4

Getting set up

We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenFreeEnergy/ExampleNotebooks

All issues in OpenFreeEnergy/ExampleNotebooks

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.