Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make clear that the readthedocs page is outdated #486

Open
glyg opened this issue Dec 21, 2022 · 5 comments · May be fixed by ISA-tools/isa-specs#12
Open

make clear that the readthedocs page is outdated #486

glyg opened this issue Dec 21, 2022 · 5 comments · May be fixed by ISA-tools/isa-specs#12

Comments

@glyg
Copy link

glyg commented Dec 21, 2022

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 added a commit to glyg/isa-specs that referenced this issue Dec 21, 2022
@glyg glyg linked a pull request Dec 21, 2022 that will close this issue
@glyg
Copy link
Author

glyg commented Dec 21, 2022

just opened a PR on the readthedocs repo

@sellth
Copy link

sellth commented Apr 27, 2023

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
Copy link
Author

glyg commented May 2, 2023

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
Copy link
Member

proccaserra commented May 2, 2023

@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
Copy link
Author

glyg commented May 3, 2023

Thank you @proccaserra I look forward for the update 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants