Skip to content

DRAFT: Add documentation for how to use the table filtering section of scicat#13

Merged
LAShemilt merged 6 commits intoSciCatProject:mainfrom
rosalindfranklininstitute:NEW-table_search_and_filter_doc
Mar 26, 2026
Merged

DRAFT: Add documentation for how to use the table filtering section of scicat#13
LAShemilt merged 6 commits intoSciCatProject:mainfrom
rosalindfranklininstitute:NEW-table_search_and_filter_doc

Conversation

@nickcrawford1
Copy link
Copy Markdown
Contributor

This MR adds a documentation to for the Scicat table and column filtering as well as saving data. It is intended as a user guide on how to navigate and operate the filtering options along with information about what will return.

Copy link
Copy Markdown
Collaborator

@LAShemilt LAShemilt left a comment

Choose a reason for hiding this comment

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

Thanks so much for putting in the time to do this. There has been an initial start to the documentation on the dashboard but I think this goes further. It would be good to amalgamate the two docs.

I would say that the structure of this should be:
/docs/datasets/DashboardTableEditing.md

The current docs can be found here:
/docs/login/Dashboard.md

I would suggest that we keep the section on the Landing Page in /docs/login/Dashboard.md, but move the content on table filtering to /docs/datasets/DashboardTableEditing.md along with the new content on saving data.

@nickcrawford1 nickcrawford1 changed the title Add documentation for how to use the table filtering section of scicat DRAFT: Add documentation for how to use the table filtering section of scicat Mar 13, 2026
@nickcrawford1
Copy link
Copy Markdown
Contributor Author

@LAShemilt I've made adjustments to the structure and taken repeated elements out of each document to avoid confusion. I think separating the files is the way to go to ensure each element is clear for the users but let me know if you're not a fan of this.

Copy link
Copy Markdown
Collaborator

@LAShemilt LAShemilt left a comment

Choose a reason for hiding this comment

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

Hi Nick, LGTM just some small changes to the wording and typos. Once applied this can be merged.

nickcrawford1 and others added 4 commits March 25, 2026 16:14
remove extra wording

Co-authored-by: LAShemilt <laura.shemilt@rfi.ac.uk>
Co-authored-by: LAShemilt <laura.shemilt@rfi.ac.uk>
Co-authored-by: LAShemilt <laura.shemilt@rfi.ac.uk>
Co-authored-by: LAShemilt <laura.shemilt@rfi.ac.uk>
@nickcrawford1
Copy link
Copy Markdown
Contributor Author

Hi @LAShemilt

Yes i agree with and have applied those changes to the documentation. Thank you for catching them.

@LAShemilt LAShemilt merged commit ca96df1 into SciCatProject:main Mar 26, 2026
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.

3 participants