Figure out where documentation and functional specs should go

Question

Figure out where documentation and functional specs should go

Opened this issue 9 years ago · 5 comments

Documentation is currently in docs within wp-content. With all of the core files having been moved to the theme, it seems to make sense that the documentation should also be there. Does it belong in taco-theme/app?

And if we're going to store functional specs in a similar fashion, I imagine it would need to be next to docs, wherever it ends up.

Answer 1 · 2016-02-09T17:36:28.000Z

The theme sounds like a good place.

Answer 2 · 2016-02-09T20:04:49.000Z

At the main theme level, not within app?

Answer 3 · 2016-02-09T20:13:02.000Z

I think at the main theme level so it can cover theme and app.

On Tue, Feb 9, 2016 at 1:04 PM, Alan Dague-Greene notifications@github.com
wrote:

At the main theme level, not within app?

—
Reply to this email directly or view it on GitHub
#15 (comment)
.

Answer 4 · 2016-02-09T20:32:11.000Z

I believe all of our compilers have the ability to compile markdown to html. Should we setup a watcher that does this for README.md?

Answer 5 · 2016-02-10T00:24:08.000Z

Having to compile introduces the possibility of Markdown and HTML getting out of sync, if someone edits the MD but doesn't compile it. (I guess the same problem theoretically exists with SCSS.) I'd want to know more about how we organize multiple HTML files.