Skip to content

Improve overview.rst with narrative and Quick Start example#165

Open
Monier-Ayman wants to merge 4 commits into
sunpy:mainfrom
Monier-Ayman:patch-1
Open

Improve overview.rst with narrative and Quick Start example#165
Monier-Ayman wants to merge 4 commits into
sunpy:mainfrom
Monier-Ayman:patch-1

Conversation

@Monier-Ayman
Copy link
Copy Markdown

@Monier-Ayman Monier-Ayman commented Feb 27, 2026

PR Description

This PR improves the overview.rst documentation file.

It:

  • Adds a clearer narrative description of radiospectra
  • Lists supported instruments with official names
  • Adds a verified Quick Start example for e-CALLISTO
  • Explains the workflow in plain English

Closes #85

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.

DOC: Improve overview.rst with narrative and quick start example

- Adds a clear description of radiospectra
- Lists supported instruments with official names
- Adds verified Quick Start example for e-CALLISTO
- Explains workflow in plain English
@Monier-Ayman
Copy link
Copy Markdown
Author

Hi @samaloney, I wanted to give you an overview of what I’ve done in this PR (#165):

  • Improved the Overview section of the documentation (overview.rst) for clarity and readability.
  • Added a Quick Start example for e-CALLISTO using the public Spectrogram API.
  • Listed all supported instruments with their official names.
  • Explained the workflow in plain English for new users.
  • Added a changelog entry and fixed it to match the PR number.
  • Ensured the changelog has the final newline for pre-commit CI checks.

This should make it easier for new users to get started with radiospectra and for reviewers to verify the changes.

@samaloney
Copy link
Copy Markdown
Member

Thanks for the PR just a few housekeeping issues please retain and use the PR template which is created when the PR is opened. (You can see it here: https://github.com/sunpy/.github/blob/main/.github/PULL_REQUEST_TEMPLATE.md)

@Monier-Ayman
Copy link
Copy Markdown
Author

Thanks for the PR just a few housekeeping issues please retain and use the PR template which is created when the PR is opened. (You can see it here: https://github.com/sunpy/.github/blob/main/.github/PULL_REQUEST_TEMPLATE.md)

@samaloney
Thanks for the guidance. I have updated the PR description to follow the template.

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.

Add Examples and more narrative documentation

2 participants