Should the blog posts be moved to the Mypy docs?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
Documentation
I just saw a comment like this on a PR to fix a typo.
I also updated the blog post.
That left me wondering, even with the new CHANGELOG.md file there is still some amount of manual work necessary for releases blog posts or even just simple typos. Should we move it to the documentation and have the blog entry posted there, always up to date with the latest stable release? To keep the blog style, it could make sense to auto-generate the individual entries from the common CHANGELOG.md file.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing CHANGELOG.md and the linked PR, then compare the current blog-post and documentation workflows. Define whether posts should move into the documentation or be generated from CHANGELOG.md, and document the agreed release process as the completion criteria.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100