manosim / manosim/django-rest-framework-docs
Support for docs versioning
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 641
- Forks
- 178
- PR merge metrics
- No merged PRs in 30d
Description
Going through the docs, I couldnt find any support for versioning of docs. May be we can arrive at an approach from where we can pick up the changes in API formats and highlight them. This feature is useful for developers to check the changes in the latest documentation compared with its predecessor.
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 the repository's documentation structure and how current Django REST Framework API formats are represented. Define the versioning approach, how predecessor comparisons should be identified, and how format changes should be highlighted; the issue is complete when those requirements are agreed and documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- django, python
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100