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

DOC: Re-structure Readme and website #66

Open
5 of 7 tasks
kay-ro opened this issue Oct 18, 2024 · 2 comments
Open
5 of 7 tasks

DOC: Re-structure Readme and website #66

kay-ro opened this issue Oct 18, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation release: minor Issues that need to be addressed in a minor release status: to do Issues that someone needs to work on

Comments

@kay-ro
Copy link
Member

kay-ro commented Oct 18, 2024

Problem description:

As discussed, we should present the "How to cite" section more prominently on the Readme and the website.
Additionally, the amep getting started website looks fairly plain on a mobile device - move to visuals instead of text.

Suggested content improvement:

  • include "how to cite" in the very beginning of the readme
  • move "datastructures" to "Userguide" on website
  • create "How to Cite" right next to "Getting Started" on website
  • start list of publications where amep has been used and include on website how to cite.
  • move feature table to very bottom of readme
  • make schematic image of amep usage for website (visuals instead of text)
  • add version selector on website (for each minor release, the most recent doc pages should be available)
@kay-ro kay-ro added documentation Improvements or additions to documentation release: minor Issues that need to be addressed in a minor release status: to do Issues that someone needs to work on labels Oct 18, 2024
@kay-ro kay-ro modified the milestones: release v1.1.0, release v1.0.3 Oct 18, 2024
@hechtprojects hechtprojects self-assigned this Oct 22, 2024
@kay-ro
Copy link
Member Author

kay-ro commented Feb 7, 2025

  • add sphinx-notfound-page for a custom 404 error page
  • add sphinx-version-warning for warning when looking at older versions

todo for version 2.0.0? #104

@kay-ro
Copy link
Member Author

kay-ro commented Feb 10, 2025

Still to fix:

  • readme-inclusion in documentation (duplication of how to cite, installation,....)
  • update text for documentation front page
  • simplify "getting started" with subsections installation,... (no sub-pages)
  • move "Benchmarks" to User Guide
  • re-organize "user guide" to simplify access to information

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 release: minor Issues that need to be addressed in a minor release status: to do Issues that someone needs to work on
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

3 participants