Skip to content

Post release doc updates - #266

Open
samaloney wants to merge 12 commits into
sunpy:mainfrom
samaloney:docs-post-release
Open

Post release doc updates#266
samaloney wants to merge 12 commits into
sunpy:mainfrom
samaloney:docs-post-release

Conversation

@samaloney

@samaloney samaloney commented Apr 22, 2026

Copy link
Copy Markdown
Member

PR Description

Update readme

  • Fix Zenodo badge use latest DOI ref (alway point to most recent release)
  • Add short pip install instructions

Update install guide

  • Add pip install section and why legacy might be needed.

Sphix-lint fixes

AI Assistance Disclosure

AI tools were used for:

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding
  • No AI tools were used

Regardless of AI use, the human contributor remains fully responsible for correctness, design choices, licensing compatibility, and long-term maintainability.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates end-user documentation to reflect post-release install guidance and refresh metadata/badges in the project README.

Changes:

  • Updated the Zenodo badge/link in README.rst.
  • Added brief pip install instructions (including the optional legacy extra) to the README.
  • Added a new “Installing the release version” section to the installation tutorial.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File Description
README.rst Updates Zenodo DOI badge and adds quick pip install instructions.
docs/tutorials/installation.rst Adds release-install instructions and adjusts surrounding installation narrative.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.rst
Comment thread README.rst
Comment thread docs/tutorials/installation.rst Outdated
Comment thread docs/tutorials/installation.rst Outdated
Comment thread docs/tutorials/installation.rst Outdated
@samaloney

Copy link
Copy Markdown
Member Author

Something weird going on with safari/github the Zenodo badge don't always render or take and age but it find on Firefox / chrome and is the same for sunpy readme too.

image

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

Successfully merging this pull request may close these issues.

4 participants