search

willkg / douglas

DEAD PROJECT: File based static rendering blog system
Other
2 stars 3 forks source link

slim docs waaaaay down #5

Open willkg opened 10 years ago

willkg commented 10 years ago

The docs are enormous. They should be slimmed way down. Anything that's complicated to document should be changed in the code so it's less complicated to document.

willkg commented 10 years ago

Issue #17 mentions how the docs should be clearer that Douglas comes with plugins and these plugins aren't copied into your plugins/ directory when you create a new blog. That should get fixed when doing this docs pass.

willkg commented 10 years ago

I did a pass on removing and reducing docs today. Still needs a lot of work, though. Part of me wonders if I shouldn't just delete all the docs and start over. That might be easier.

willkg commented 10 years ago

Did a pass on configuration and pulled it all into one file.

willkg commented 10 years ago

I removed a lot of documentation that was either definitely wrong or probably wrong. I removed a lot of redundant redundancy. I added some stubs for things that should be written.

This is kind of a vague issue, but there's probably still a bunch of work to do, so I'll just leave it open for a while.