nf-core / nf-core/website

Versioning for documentation / guidelines

Open
#2,821 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
MDX
Stars
98
Forks
298
Avg merge
14h 38m
Merged PRs (30d)
38

Description

Is your feature request related to a problem? Please describe.
Regulatory authorities will require us to have versioned pages.

Describe the solution you'd like
Versions of the webpage would help with this - e.g. V1.1., V2.0, ... of specific subpages even.

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

The issue names no files, tests, or entry points. Start by clarifying whether versioning applies to all pages or selected subpages, and how versions should be displayed and maintained. Done should include an agreed versioning scope and a documented way for readers to access the required page versions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.