OpenFreeEnergy / OpenFreeEnergy/openfe

Minor docs CSS style improvements

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

Nobody has claimed this yet.

1.0docdrive
Dominant language
Python
Stars
331
Forks
56
Avg merge
3d 9h
Merged PRs (30d)
13

Description

Following on #419:

  • When there's a toctree that only has one level (no nesting), it isn't immediately obvious to me that those are links. See Core Models, Simulation Setup.
  • Play with the CSS on the code sections
  • Figure out better CSS for <select> elements (see Installation), although these default to being OS/Browser specific, so this may be a pain.

Contributor guide

Open the contributing guide

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.

Research direction

Start with the documentation pages Core Models, Simulation Setup, and Installation, then inspect the documentation CSS affecting toctrees, code sections, and elements. Done means single-level toctree links are visibly identifiable and the code and select styling is improved without obscuring browser or OS-specific behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
css
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.