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

docs improvements #471

Open
2 of 11 tasks
slayoo opened this issue Oct 31, 2024 · 2 comments
Open
2 of 11 tasks

docs improvements #471

slayoo opened this issue Oct 31, 2024 · 2 comments

Comments

@slayoo
Copy link
Member

slayoo commented Oct 31, 2024

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

@Sfonxu
Copy link
Contributor

Sfonxu commented Nov 20, 2024

Found something interesting regarding dark mode/high contrast mode for pdocs, might be worth considering
mitmproxy/pdoc#210
https://github.com/mitmproxy/pdoc/tree/main/examples/dark-mode

@AgnieszkaZaba
Copy link
Collaborator

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

No branches or pull requests

3 participants