You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Here are notes from our today's discussion re docs improvement:
add an option to display the docs in high-contrast mode (likely a feature that could be actually added to pdoc itself)
disable menu icon (visible if browsing on mobile devices) for the project landing page (where there is no menu)
enrich visually the algorithm description (could be linked with incorporation of numerics-related tutorial content)
identify the audience of the docs and ensure that relevant content is present (e.g., student new to MPDATA; someone familiar with MPDATA; someone unfamiliar with Numba, ...)
add a reference-list page with automatic checks if all DOIs used in the docs are mentioned there
add a Credits page acknowledging contributions with developer identities
add logos (AGH, Numba, numba-mpi, NCN, FNP, ...)
add on the homepage a list of MPDATA variants implemented with surname-labeled links to the relevant papers
move logo files in the repo from .github folder to docs folder
repeat what is relevant from the above for PySDM, PyPartMC, numba-mpi, PyMPDATA-MPI
CC @pawelmagnu, @olastrz, @Sfonxu, @emmacware
Here are notes from our today's discussion re docs improvement:
add an option to display the docs in high-contrast mode (likely a feature that could be actually added to pdoc itself)
disable menu icon (visible if browsing on mobile devices) for the project landing page (where there is no menu)
enrich visually the algorithm description (could be linked with incorporation of numerics-related tutorial content)
identify the audience of the docs and ensure that relevant content is present (e.g., student new to MPDATA; someone familiar with MPDATA; someone unfamiliar with Numba, ...)
add a reference-list page with automatic checks if all DOIs used in the docs are mentioned there
add a Credits page acknowledging contributions with developer identities
add logos (AGH, Numba, numba-mpi, NCN, FNP, ...)
add on the homepage a list of MPDATA variants implemented with surname-labeled links to the relevant papers
move logo files in the repo from .github folder to docs folder
repeat what is relevant from the above for PySDM, PyPartMC, numba-mpi, PyMPDATA-MPI
max width for images: 100% #482
The text was updated successfully, but these errors were encountered: