search

haulrich / improv

WordPress theme for Pro Deo
0 stars 1 forks source link

Make a read me #39

Open Vescatur opened 3 years ago

Vescatur commented 3 years ago

It might be nice to have a read me document for a future person working on this. I think the goal of a read me should be that a technical person could make a change to the website without prior knowledge of WordPress. Things I think would be useful are:

1) Structure of the code (somebody needs to know where to change something) 2) How to change the code of the website 2.1) List of tools used for development. (Maybe reference to documentation) 2.2) How to run it on a local machine 2.3) How to upload it to prodeo.utwente.nl 2.4) (Maybe list of plugins used. This might be more trouble then it is worth because it would need to be updated each time.) 3) How to change content of the website

I think for most of the points references to relevant documentation would be the preferred option instead of typing it out.

haulrich commented 3 years ago

Good one! I never had one, and aside from my knowledge of WP there was also the 'personal style of the former developer' I had to deal with. I'm sure I do have a personal style too and I'd like people to get along with that, not throw it overboard because it might look bizarre.