isa-api icon indicating copy to clipboard operation
isa-api copied to clipboard

make clear that the readthedocs page is outdated

Open glyg opened this issue 2 years ago • 5 comments

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

glyg avatar Dec 21 '22 08:12 glyg

just opened a PR on the readthedocs repo

glyg avatar Dec 21 '22 08:12 glyg

Is it outdated though? Seems like https://isa-tools.org does not describe the ISA model and links several times to the readthedocs page.

sellth avatar Apr 27 '23 13:04 sellth

Hi @sellth thanks for the reply. My issue is that the isa-tools graph view of the model:

And the view from readthedocs:

are close but not identical, and the abstract model section does not mention a process concept, for exemple, although the schema section does and seems consistent with the graph in isa-tools.

So maybe only the graph and the first section of the docs should be updated?

glyg avatar May 02 '23 07:05 glyg

@sellth @glyg, thank you for highlighting these discrepancies. We'll address these issues along with updating the website and jupyter notebooks to reflect all the recent fixes to the API.

The ISA model defined as JSON schema is available from this address: https://github.com/ISA-tools/isa-api/tree/master/isatools/resources/schemas/isa_model_version_1_0_schemas/cor

atb

P

proccaserra avatar May 02 '23 19:05 proccaserra

Thank you @proccaserra I look forward for the update :smile:

glyg avatar May 03 '23 07:05 glyg