agateblue / agateblue/django-dynamic-preferences

Documentation about FilePreference is too light

Open
#300 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
359
Forks
86
PR merge metrics
No merged PRs in 30d

Description

The documentation of the preference type `FilePreference` is a bit light.

Event after searched info in the documentation website: https://django-dynamic-preferences.readthedocs.io

There is some missing informations. Like:
- Are the file stored as static file or media file
- How to use the file from a tamplate
- How to configure where the file is uploaded

And the example is a bit short. Is it an example of preference definition, or also an example of usage ?
It's a bit confusing.

Maybe a section dedicated to this type of preference could help understand it.

I would love to help about it, but as I didn't understand how to use FilePreference, I can do nothing.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.