Skip to content

DOC/website: Redesign landing page of PyGMT website - #4762

Open
yvonnefroehlich wants to merge 89 commits into
mainfrom
create-website-cards
Open

DOC/website: Redesign landing page of PyGMT website#4762
yvonnefroehlich wants to merge 89 commits into
mainfrom
create-website-cards

Conversation

@yvonnefroehlich

@yvonnefroehlich yvonnefroehlich commented Jul 25, 2026

Copy link
Copy Markdown
Member

Description of proposed changes

Currently trying out different ideas and approaches regarding improving the PyGMT website, especially the landing page. Seeing / experimenting how different layouts would look like, using grids, cards, buttons, and icons (xref: https://sphinx-design.readthedocs.io/en/rtd-theme/index.htm).

Fixes #4746

Disscussion (see also issue #4746)

  • How many cards do we want?
  • Use same structur as side bar? One card per main sections or cards only for specific topics?
  • Coloring of cards? Globally or different for the landing page and External Resources?
  • Add a new main section Project Overview (or similar)? Reorder sidebar partly?

Preview

(I) (II) a (II) b
image image image

Major changes

  • Use cards on landing page
    • (I) Cards similar to the main sections: 6 cards as 3 columns and 2 rows (laptop) or vertical (smartphone), buttons for subsections
    • (II) a / b Card for specific topics: 9 cards as 3 columns and 3 rows (laptop) or vertical (smartphone)
  • Add new section Project Overview
    • Why PyGMT
      • Project Goals <- from README
      • Background <- from Getting Started/Overview
      • Support <- from README (maybe rename to Funding)
      • Related Projects <- from README
    • PyGMT Ecosystem <- from Reference Documentation
    • Citing PyGMT with G^3 paper and Zenodo BibTex <- from README
    • Conference Presentations <- from Getting Started/Overview
  • Reorder sidebar
    • Overview to Project Overview/Background, Conference Presentations (before Getting Started)
    • Minimum Supported Version to Getting Started (before Reference Documentation)
    • PyGMT Ecosystem to Project Overview (before Reference Documentation)
    • Changelog to Development (before Reference Documentation)

Make things look nice

  • Centering text on landing page
  • Vertical spaces between PyGMT logo and text on lading page
  • Add icons to the headings of the cards
  • Use buttons instead of bullet point lists

General things

  • Add PyGMT logo on landing page via Sphinx markdown instead of html
  • Links / URLs: In the README we use latest. This is fine for GitHub, but not optimal for the website as dev links to latest of the linked doc page not dev -> Rewrite text for docs, do not reuse from README
  • Rename section Getting Help and Contributing to Getting Help -> Where?
  • Sort tutorials on the External Resoures page by year (or date)
  • Add possiblity to link to main sections -> Needed?

Resources

@yvonnefroehlich
yvonnefroehlich marked this pull request as draft July 25, 2026 10:17
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
@seisman seisman removed maintenance Boring but important stuff for the core devs discussions Need more discussion before taking further actions labels Aug 6, 2026
yvonnefroehlich and others added 4 commits August 6, 2026 19:45
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
@yvonnefroehlich yvonnefroehlich changed the title POC: WIP: DOC/website: Redesign landing page of PyGMT website DOC/website: Redesign landing page of PyGMT website Aug 6, 2026
@yvonnefroehlich
yvonnefroehlich marked this pull request as ready for review August 6, 2026 20:46
Comment thread doc/index.md
Comment thread doc/index.md Outdated
@seisman seisman added skip-changelog Skip adding Pull Request to changelog final review call This PR requires final review and approval from a second reviewer labels Aug 7, 2026
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment thread doc/index.md Outdated
Comment on lines +125 to +139
:::{button-ref} team
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} contributing
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} maintenance
:color: secondary
:outline:
:shadow:
:::

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Move "team" after "maintenance".

Suggested change
:::{button-ref} team
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} contributing
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} maintenance
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} contributing
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} maintenance
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} team
:color: secondary
:outline:
:shadow:
:::

Comment thread doc/index.md Outdated
Comment on lines 218 to 220

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
contributing.md
maintenance.md
team.md

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 final review call This PR requires final review and approval from a second reviewer skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants