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.

Sign up for GitHub

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

Jump to bottom

Improve README.rst with TOC and clearer instructions #16475

Merged
merged 9 commits into from
May 21, 2024
Merged

Improve README.rst with TOC and clearer instructions #16475

merged 9 commits into from
May 21, 2024

Conversation

Brandie-M
Copy link
Contributor

Description

This pull request updates the README.rst file to improve its readability and clarity. The following changes have been made:

  1. Added Table of Contents: To provide easy navigation through the document.
  2. Updated Installation Instructions: Provided a brief command example for installing Astropy using pip.
  3. Cleaned Up Local Clone Heading: Improved the heading for the instructions for updating local clones from master to main.

These changes aim to enhance the usability of the README, making it more user-friendly for contributors and users alike.

Before:
image

After:
image

Testing:

  • Previewed the README in a reStructuredText viewer to ensure proper rendering.
  • Verified all links and sections in the Table of Contents work correctly.

Additional Notes:

  • Please review the new sections and provide feedback if further changes are needed.
  • Suggestions for additional improvements are welcome.

Thank you for your consideration.

Fixes #16474

  • By checking this box, the PR author has requested that maintainers do NOT use the "Squash and Merge" button. Maintainers should respect this when possible; however, the final decision is at the discretion of the maintainer that merges the PR.

@github-actions github-actions bot added the Docs label May 20, 2024
@github-actions GitHub Actions
Copy link

Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.

  • Do the proposed changes actually accomplish desired goals?
  • Do the proposed changes follow the Astropy coding guidelines?
  • Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
  • Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
  • Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see instructions for rebase and squash.
  • Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the "Extra CI" label. Codestyle issues can be fixed by the bot.
  • Is a change log needed? If yes, did the change log check pass? If no, add the "no-changelog-entry-needed" label. If this is a manual backport, use the "skip-changelog-checks" label unless special changelog handling is necessary.
  • Is this a big PR that makes a "What's new?" entry worthwhile and if so, is (1) a "what's new" entry included in this PR and (2) the "whatsnew-needed" label applied?
  • At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate "backport-X.Y.x" label(s) before merge.

github-actions[bot]
github-actions bot reviewed May 20, 2024
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to Astropy 👋 and congratulations on your first pull request! 🎉

A project member will respond to you as soon as possible; in the meantime, please have a look over the Checklist for Contributed Code and make sure you've addressed as many of the questions there as possible.

If you feel that this pull request has not been responded to in a timely manner, please send a message directly to the development mailing list. If the issue is urgent or sensitive in nature (e.g., a security vulnerability) please send an e-mail directly to the private e-mail [email protected].

@pllim pllim added this to the v7.0.0 milestone May 21, 2024
pllim

This comment was marked as resolved.

Sign in to view

@Brandie-M
Copy link
Contributor Author

URLs updated from HTTP to HTTPs.

eerovaher
eerovaher reviewed May 21, 2024
View reviewed changes
README.rst Show resolved Hide resolved
eerovaher
eerovaher reviewed May 21, 2024
View reviewed changes
README.rst Outdated Show resolved Hide resolved
pllim
pllim reviewed May 21, 2024
View reviewed changes
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
pllim
pllim approved these changes May 21, 2024
View reviewed changes
Copy link
Member

@pllim pllim left a comment

Choose a reason for hiding this comment

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

LGTM now. Nice clean-up. Thanks!

@pllim
Copy link
Member

pllim commented May 21, 2024

pre-commit.ci autofix

@pllim
Copy link
Member

pllim commented May 21, 2024

No need to wait for CI. This is just the README and it renders fine on GitHub.

@pllim pllim merged commit f3e40c0 into astropy:main May 21, 2024
12 of 25 checks passed
@nstarman nstarman mentioned this pull request May 22, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eerovaher eerovaher eerovaher left review comments

@github-actions github-actions[bot] github-actions left review comments

@pllim pllim pllim approved these changes

Assignees
No one assigned
Labels
Docs no-changelog-entry-needed
Projects
None yet
Milestone
v7.0.0
Development

Successfully merging this pull request may close these issues.

Improve README.rst readability with TOC and clearer instructions
3 participants
@Brandie-M @pllim @eerovaher