ISA-tools / ISA-tools/isa-api

make clear that the readthedocs page is outdated

Open
#486 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
48
Forks
42
PR merge metrics
No merged PRs in 30d

Description

Hi,
It seems the latest documentation (although I am not clear if ISA version 1.0 or 2.0 should be used) is here:
https://isa-tools.org/isa-api/content/index.html

Search engines mostly return this page:
https://isa-specs.readthedocs.io/en/latest/

Could there be a redirection to the former from the latter? The schemas and nodes are very different between the two

Thanks,
Guillaume

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

Compare the outdated Read the Docs page at isa-specs.readthedocs.io/en/latest/ with the current documentation at isa-tools.org/isa-api/content/index.html, and inspect the repository's documentation or hosting configuration to locate the redirect entry point. Confirm whether ISA version 1.0 or 2.0 is canonical, then verify that visitors from the old URL reach the intended documentation.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.