Skip to content

Multiple Documentation Updates #313

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

Open
6 tasks
jjacobson95 opened this issue Jan 27, 2025 · 2 comments
Open
6 tasks

Multiple Documentation Updates #313

jjacobson95 opened this issue Jan 27, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jjacobson95
Copy link
Collaborator

jjacobson95 commented Jan 27, 2025

The Documentation site needs a bit more fine tuning.

  • In-line code blocks are overlapping each other. We can either adjust the code block padding or add more space between lines of text.
  • Check for typos (not sure how many are present but I've noticed few so far - "trining", "respones", "referr", "sucessfully", etc)
  • Mention use case for each split_type. I think a bit more context could be helpful for users. Maybe even add a table for further explanation.
  • Check that all in-page links work. Additionally make sure that they bring you to the write place, currently the header is not calculated into where the page should refocus at.
  • More explanation for thresh, num_classes, quantiles usages.
  • This can be put in a different issue, but we should discuss what we information we want for each of the datasets - currently this still has broad_sanger as a single dataset.
@jjacobson95 jjacobson95 added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 27, 2025
@jjacobson95 jjacobson95 changed the title Docs In-line code blocks need adjusted spacing Multiple Documentation Updates Jan 27, 2025
@ymahlich
Copy link
Collaborator

need to change the link to figshare in the Resources tab

@jjacobson95
Copy link
Collaborator Author

jjacobson95 commented Jan 30, 2025

This link is automatically updated - I think it is only outdated because the latest version of the docs were built on a branch with an outdated docs/_data/figshare_latest.yaml file. I'll go ahead and rebuild from main and confirm.

Edit - Building on main updated the figshare link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: No status
Development

No branches or pull requests

2 participants