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.

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

Rewrite minimal reproduction guide to get to the point quicker #28730

Open
9 tasks
HonkingGoose opened this issue Apr 29, 2024 · 0 comments
Open
9 tasks

Rewrite minimal reproduction guide to get to the point quicker #28730

HonkingGoose opened this issue Apr 29, 2024 · 0 comments
Assignees
Labels
priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation

Comments

@HonkingGoose
Copy link
Collaborator

HonkingGoose commented Apr 29, 2024

Describe the proposed change(s).

Rewrite the minimal reproduction guide 1, so that users can get started creating the reproduction quicker:

  • Refactor current docs with: docs: improve minimal reproductions guide #28926
  • Move actionable information up front
  • Move background info down
  • Rewrite for simplicity:
    • Simpler words
    • Short sentences
    • Use lists if needed
    • Focus on the reader
    • Update links that point to minimal-reproductions.md

Footnotes

  1. docs/development/minimal-reproductions.md

@HonkingGoose HonkingGoose added priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation labels Apr 29, 2024
@HonkingGoose HonkingGoose self-assigned this Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation
Projects
None yet
Development

No branches or pull requests

1 participant