exercism / exercism/java

Find a way to always have reference documentation updated

Open
#2,728 4 comments 1 reaction 0 assignees View on GitHub
discussion documentation x:knowledge/elementary
Dominant language
Java
Stars
834
Forks
779
Avg merge
1d 1h
Merged PRs (30d)
3

Description

Yeah, I thought that the variables accept plain text, but it seems that they only accept URLs. However, I still think we should find a way to handle this, because currently, we have a ton of documentation for different Java versions – 7, 8, 9, 11, 12, 13, 14, etc. Perhaps a policy to only add documentation for the latest current version, but that wouldn't eliminate the need to update the older ones at some point.

_Originally posted by @manumafe98 in https://github.com/exercism/java/issues/2722#issuecomment-1928531785_

Contributor guide

Open the contributing guide

Research direction

Review the discussion in issue #2722 and the current Java-version documentation setup; this issue names no files, tests, or entry points. First clarify whether the desired outcome is a maintenance policy or an automated mechanism. Done means an agreed approach for keeping documentation across Java versions current.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.