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

Added column descriptions #129

Merged
merged 2 commits into from
Sep 28, 2024
Merged

Conversation

DanielaSchacherer
Copy link
Contributor

Added column descriptions for sm_indices.

added description of columns in sm_instance_index and sm_index.
@fedorov
Copy link
Member

fedorov commented Sep 20, 2024

@DanielaSchacherer instead of embedding the new page into the main documentation page, could you look if it is possible to have it as a separate page, and just link to it from the front page?

Also, note that you can see the preview of the branch documentation in the list of checks for the PR: https://idc-index--129.org.readthedocs.build/en/129/.

minor text changes

updated ImageType description

check if include command works now

Moved section introducing indices of idc-index into README

Test to see if docs are build correctly

Docs: Added separate page for column description of indices and linked to it from README.

removed test

fixed link

removed doubled text

adapted toctree to generate column_descriptions.html

corrected toctree

another try

next try

a test

probably solved

added title and sections
@DanielaSchacherer
Copy link
Contributor Author

@fedorov I moved the section introducing the indices of idc-index into the README, and linked the column descriptions from there.
Before, the whole section has been hidden behind Acknowledgements and will probably be overseen by some people.

Copy link
Member

@fedorov fedorov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DanielaSchacherer you forgot to make a new branch for this PR! But fortunately this one won't require back and forth.

@fedorov fedorov merged commit 5c56beb into ImagingDataCommons:main Sep 28, 2024
10 checks passed
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 this pull request may close these issues.

2 participants