8000 Consider updating the user documentation to point to existing feature requests · Issue #7994 · sunpy/sunpy · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Consider updating the user documentation to point to existing feature requests #7994

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
Open
ehsteve opened this issue Jan 9, 2025 · 2 comments
Open

Consider updating the user documentation to point to existing feature requests #7994

ehsteve opened this issue Jan 9, 2025 · 2 comments
Labels
Documentation Affects the documentation. Feature Request New feature wanted.

Comments

@ehsteve
Copy link
Member
ehsteve commented Jan 9, 2025

Describe the feature

The user and developer documentation could be better integrated in order to encourage conversion of users to contributors.

Proposed solution

In order to encourage contributions and make it known that areas of code have suggested improvements, consider adding links to issues/roadmap areas as notes to the documentation. Users and potentially contributors would then see (when using the documentation) that classes and functions may change, how they might change, and let them know that they could help improve them.

This may have to happen programmatically so that these notes are removed when an issue is closed or only pointing to large roadmap changes which do not change that quickly and could be updated by hand.
@ehsteve ehsteve added Feature Request New feature wanted. Documentation Affects the documentation. labels Jan 9, 2025
@ehsteve
Copy link
Member Author
ehsteve commented Jan 9, 2025

ping @hayesla @DanRyanIrish. Here is another idea based on the discussion yesterday.

@nabobalis
Copy link
Member
5FC3

How do you expect this to work?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Affects the documentation. Feature Request New feature wanted.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ehsteve @nabobalis
0