Skip to content

Add Documentation - #305

Merged
Cadair merged 11 commits into
sunpy:mainfrom
Cadair:docs_take1
Aug 11, 2026
Merged

Add Documentation#305
Cadair merged 11 commits into
sunpy:mainfrom
Cadair:docs_take1

Conversation

@Cadair

@Cadair Cadair commented Aug 11, 2026

Copy link
Copy Markdown
Member

This isn't perfect by a long shot, but it's better than nothing and also a good place to start for future improvements.

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.

I mainly had the AI figure out all the things I should cover, I wrote most of the words.

@samaloney samaloney 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.

Nice looks good based on brief read over. As you say I'm sure when it is used some potential improvements may surface.

@Cadair
Cadair merged commit 4ba8b7c into sunpy:main Aug 11, 2026
13 checks passed
@Cadair
Cadair deleted the docs_take1 branch August 11, 2026 15:36
@Cadair Cadair mentioned this pull request Aug 12, 2026
3 tasks
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.

2 participants