Skip to content

README: Reorganize structure - #4800

Merged
seisman merged 24 commits into
mainfrom
polish-readme
Aug 8, 2026
Merged

README: Reorganize structure#4800
seisman merged 24 commits into
mainfrom
polish-readme

Conversation

@yvonnefroehlich

@yvonnefroehlichyvonnefroehlich commented Aug 6, 2026•
edited
Loading

Copy link
Copy Markdown
Member

Description of proposed changes

Related to #4746

xref: #4786 (comment)

Preview: https://github.com/GenericMappingTools/pygmt/tree/polish-readme#a-python-interface-for-the-generic-mapping-tools

Guidelines

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@yvonnefroehlichyvonnefroehlich added this to the 0.20.0 milestone Aug 6, 2026
@yvonnefroehlichyvonnefroehlich self-assigned this Aug 6, 2026
@yvonnefroehlichyvonnefroehlich added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Aug 6, 2026
@yvonnefroehlich
yvonnefroehlich marked this pull request as draft August 7, 2026 10:52
seisman
seisman reviewed Aug 7, 2026
View reviewed changes
Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
seisman
seisman reviewed Aug 7, 2026
View reviewed changes
Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
yvonnefroehlichand others added 3 commits August 7, 2026 17:09
@yvonnefroehlich@seisman
Remove 'Min Sup versions' lists from Documentation list
e62cff1
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@yvonnefroehlich@seisman
Improve formulation
6bf83a5
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@yvonnefroehlich
Revert "Include 'Dependencies' into 'Quickstart'"
34d4743
This reverts commit 373c227.
seisman
seisman reviewed Aug 8, 2026
View reviewed changes
Comment threadREADME.md Outdated
seisman
seisman reviewed Aug 8, 2026
View reviewed changes
Comment threadREADME.md Outdated
Comment threadREADME.md
seisman
seisman reviewed Aug 8, 2026
View reviewed changes
Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
@yvonnefroehlich@seisman
Improve intro text
9ce9ba7
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@yvonnefroehlich
yvonnefroehlich marked this pull request as ready for review August 8, 2026 11:59
seisman
seisman reviewed Aug 8, 2026
View reviewed changes
Comment threadREADME.md Outdated
Comment threadREADME.md
seisman
seisman approved these changes Aug 8, 2026
View reviewed changes

@seismanseisman left a comment

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.

Looks good except two minor comments.

Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
yvonnefroehlichand others added 2 commits August 8, 2026 19:59
@yvonnefroehlich@seisman
Improve formulation
e450ae9
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@yvonnefroehlich@seisman
Use white spaces for indent
df17dc4
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@seisman
seisman merged commit 820f5d9 into mainAug 8, 2026
9 of 10 checks passed
@seisman
seisman deleted the polish-readme branch August 8, 2026 18:07
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seismanseismanseisman approved these changes

Assignees

@yvonnefroehlichyvonnefroehlich

Labels

documentationImprovements or additions to documentationskip-changelogSkip adding Pull Request to changelog

Projects

None yet

Milestone

0.20.0

Development

Successfully merging this pull request may close these issues.

2 participants

@yvonnefroehlich@seisman