Skip to content

Revamp the README#157

Open
samaloney wants to merge 7 commits intosunpy:mainfrom
samaloney:doc-update-readme
Open

Revamp the README#157
samaloney wants to merge 7 commits intosunpy:mainfrom
samaloney:doc-update-readme

Conversation

@samaloney
Copy link
Copy Markdown
Member

@samaloney samaloney commented Jul 12, 2024 •
edited
Loading

  • Update install section (publish package on pypi)
  • Once the example gallery PR is merged check links work

@samaloney samaloney added the No Changelog Entry Needed Skip all changelog checks. label Apr 16, 2026
@samaloney
Copy link
Copy Markdown
Member Author

samaloney commented Apr 16, 2026

You can see how the readme looks rendered on my fork https://github.com/samaloney/sunkit-spex/tree/doc-update-readme

@samaloney samaloney marked this pull request as ready for review April 16, 2026 11:21
@Cadair
Copy link
Copy Markdown
Member

Cadair commented Apr 16, 2026

If you haven't, can you try and match the sections you are keeping with the package template?

@samaloney
Copy link
Copy Markdown
Member Author

samaloney commented Apr 16, 2026

Like placement / order or the actual content of the sections? The AI one should be word for word and the contributing one is different I could use the template content and change the links?

@Cadair
Copy link
Copy Markdown
Member

Cadair commented Apr 16, 2026

Well order is helpful, and yeah for other repos I've changed some links (but we should probably template more links sometime).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

No Changelog Entry Needed Skip all changelog checks.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@samaloney @Cadair