OpenEnergyPlatform / OpenEnergyPlatform/organisation

[User-Guiding] Extend the "home" button sytle to guide user back to oep website

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

Nobody has claimed this yet.

compendium documentation enhancement
Dominant language
CSS
Stars
10
Forks
5
PR merge metrics
No merged PRs in 30d

Description

Recently I saw a user interface created by GitHub that takes the user from an external page back to the "GitHub home page". I'm posting this here as inspiration, as I'm not entirely happy with our current approach of inserting the link to OpenEnergyPlatform into the home button of the mkdocs pages, which normally takes you back to the home page of the current website.

We can modify the style to have something similar.

image

Contributor guide

No contributing guide indexed for this repository

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

No file, test, or entry point is named. Start by locating the MkDocs home-button styling and reviewing the linked inspiration; done means the OpenEnergyPlatform link is presented in a revised style while preserving a route to the current website's home page.

Written by the indexing model from the issue text.

Assessment

Tech stack
css
Domain
design, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.