"Documenting your API" topic slightly outdated

[rpkilby]

Was fixing a broken link and noticed that the referenced section no longer exists in the schemas docs.

django-rest-framework/docs/topics/documenting-your-api.md

Lines 224 to 225 in 9850441

	Note that when using viewsets the basic docstring is used for all generated views. To provide descriptions for each view, such as for the the list and retrieve views, use docstring sections as described in [Schemas as documentation: Examples][schemas-examples].

[markopy]

The missing documentation is for the ViewSet docstring format. See: https://stackoverflow.com/questions/57367230/how-to-dinstinctly-document-possible-rest-actions-in-viewset-docstring/58435631#58435631

[cyberpunk-akash]

Hi, I'm new to open source and wish to contribute to this repo as I am an active user of Django-REST. Have sufficient knowledge of Git. Can someone please explain in layman terms how to clear this issue. Would be very grateful of you. Cheers!

[rpkilby]

Hi @cyberpunk-akash. Thanks for your interest! There isn't really a direct fix here - it's more a question of how we want to structure this specific docs section, which is a question for other maintainers. e.g., do we want to leave it in the outdated coreapi docs, or do we want to move it into the main docs? Are the specific examples still supported, or are they no longer relevant given that coreapi is no longer supported?

Closing, as this issue is being addressed in #6967.