ISA-tools / isa-api

ISA tools API
https://isa-tools.org
Other
40 stars 37 forks source link

make clear that the readthedocs page is outdated #486

Open glyg opened 1 year ago

glyg commented 1 year ago

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 commented 1 year ago

just opened a PR on the readthedocs repo

sellth commented 1 year ago

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

glyg commented 1 year ago

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?

proccaserra commented 1 year ago

@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

glyg commented 1 year ago

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