search

CouchCMS / Documentation

Documentation for CouchCMS
http://docs.couchcms.com/
6 stars 3 forks source link

PR to add basic documentation on the no_results tag #19

Closed NTpspE closed 6 years ago

NTpspE commented 6 years ago

Hi there,

I've created the page for the no_results tag, and added a link to it from the pages page.

Please have a look and let me know if I've done everything correctly, I did the edits from within github rather than cloning and using wintersmith, so if I've done anything that breaks that setup let me know (as far as I can tell it's all static so should be good).

If it's all good then I'll be happy to see what other parts of the documentation I can improve :)

cheesypoof commented 6 years ago

Hi @NTpspE.

This repository has for some time now been neglected as an increasing number of Couch tags and functionality have been added to the core CMS, only to be exclusively documented within the forums. So, thank you sincerely for making efforts to contribute to the documentation and correct this undesirable state. I'm afraid that I just don't have the bandwidth to complete the job.

The repository readme file provides a ... terse description of how one should go about making changes to the documentation. Utilizing the static site generator (Wintersmith) is I'm afraid, a necessary part of the workflow. All content additions/edits should occur to the md files within src/contents. Wintersmith then uses these files to generate the HTML markup. This provides us with some flexibility as we are separating the documentation content from its presentation.

I understand if you may not wish to take on these additional tasks. Let me know if you have any questions.

NTpspE commented 6 years ago

Hi Cheesypoof,

Ah okay, well that's not a problem, I'll see about getting Wintersmith set up and do the edits to the sources and add a pr once done.