search

dmptrluke / django-markdownfield

A simple custom field for Django that can safely render Markdown and store it in the database.
MIT License
44 stars 13 forks source link

Documentation needs to be clearer - very simple step missing #28

Closed CarlMurray closed 1 year ago

CarlMurray commented 1 year ago

As a beginner it was definitely not obvious that I had to add "markdownfield" to my INSTALLED_APPS. I spent almost an hour banging my head against a wall until I finally decided to look for a different package - only when looking at docs for other packages did I realise that maybe I had to add it to my INSTALLED APPS.

A single sentence on the package documentation page would save a lot of headache. Please add this step to the docs. It's not obvious for beginners.

benjaoming commented 1 year ago

Thanks for the feedback, please have a look at the PR and LMK if there are tweaks you'd like to add :+1:

CarlMurray commented 1 year ago

Whoops I just made a PR before I saw yours. Looks good though thanks for the quick response!

benjaoming commented 1 year ago

Ah okay, I read your issue description "Please add this step to the docs. It's not obvious for beginners" and thought you were definitely not gonna do it :smile:

CarlMurray commented 1 year ago

I wasn't going to, but then realise I could (I'm new to this stuff) 😄