marcuskammer/coleslaw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

More notes.

Browse source
This commit is contained in:
Brit Butler 2014-08-15 17:02:06 -04:00
parent 99e87c061f
commit c2920901fa
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/hacking.md
View file

@ -227,7 +227,7 @@ coleslaw if there's a problem during a build is unpleasant
at best, especially for anyone not coming from the lisp world.
We need to start handling errors and reporting errors in ways
that are useful to the user. The two most obvious areas seem to be:
that are useful to the user. Example errors users have encountered:
1. Loading of Content. If `read-content` fails to parse a file, we
should tell the user what file failed and why.
@ -235,6 +235,14 @@ that are useful to the user. The two most obvious areas seem to be:
do not currently error. They just wind up returning whitespace.
When the theme compiles, we should alert the user to any obvious
issues with it.
3. Trying to load content from the bare repo instead of the clone.
i.e. Specifying the `:repo` in .coleslawrc as the bare repo.
The README should clarify this point and the need for posts to be
".post" files.
4. `:staging-dir`, `:repo`, `:deploy-dir` should all have trailing
slashes. This is a subtle, unenforced issue not mentioned in
documentation. This is exactly the sort of thing the next release
should strive to fix. (Also, `:repo` can probably be deprecated...)
### Scripting Conveniences/Basic Install