mapstruct / mapstruct/mapstruct.org

Add 1.2 Beta docs and download to website

Open
#46 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
71
Forks
40
PR merge metrics
No merged PRs in 30d

Description

I like what Django is doing: https://docs.djangoproject.com/en/1.8/intro/overview/#install-it

  • Have a selector overlay allowing to switch between versions
  • on the main page (http://mapstruct.org/documentation/reference-guide/), there should only be a link to "stable" and "dev", pointing to the current stable and work-in-progress versions
  • on older versions (as reachable through that selector) there should be a red banner of sorts warning about this being not the current version
  • on the dev version (as reachable through that selector and from the main page) there should be a yellow banner warning about this being a future work-in-progress version

A useful resource: http://webmasters.stackexchange.com/questions/99867/how-to-correctly-mark-up-different-versions-of-the-same-document-which-are-non-c

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

Start by reviewing the website's documentation reference guide and the existing version navigation and page styling. Implement the version selector and the stated stable, dev, outdated-version, and work-in-progress warnings; done means each version can be reached as described and displays the appropriate warning.

Written by the indexing model from the issue text.

Assessment

Tech stack
css
Domain
documentation, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.