add docs site

[andrewpbray]

@paciorek Here was a first attempt at providing an easy reference to what the different templates look like. I could publish template.qmd to quarto.pub and link in the repo / readme so folks could browse before they buy.

The issue is that you've provided an example of a raw schedule file instead of the schedule file that is processed by scheduled-docs. What are your thoughts on whether it makes to shift to the latter format in our example.ymls?

[andrewpbray]

I've revised the approach here: instead of documenting the templates in template.qmd, there is a new docs subdir that has the documentation for the extension (we use this approach for closeread).

The current issue that I can't figure out: when rendering the docs site, it appears to be finding the schedule.ejs just fine but not the schedule-example.ejs. I can get it to work if I move that file out of the extensions folder and into the root of the website, but that seems less than ideal.

[paciorek]

I'm a bit confused on a couple things:

1. My schedule-badge/schedule-example.yml does have the scheduled-docs key-value pairs. So I think it is in the format processed by scheduled-docs.
2. I'm not seeing docs in course-website-ejs...
3. Not sure what you mean by schedule-example.ejs. The example file is a yml file, not ejs.

If you're around, perhaps easiest to discuss directly.

[andrewpbray]

1. Whoops, I worded that incorrectly. Yes, that file is in the correct format to be processed by scheduled-docs. If we want to have it be immediately processable by the ejs templates, though, it needs to be in the format that is output by scheduled-docs (i.e. with an array at the top level). For instructors, having the input file there is more helpful - that's how their _schedule.yml should look. For people wanting to understand how the ejs template looks independent of scheduled-docs (and for documentation purposes), the output format would be more useful. As is, scheduled-docs is effectively a dependency of these ejs templates. One solution would be to provide both input and output.
2. Be sure you're looking in the fleshout-template branch: https://github.com/qmd-lab/course-website-ejs/tree/fleshout-template
3. You're right, that's a typo: I meant schedule-example.yml.

[andrewpbray]

Here is a published docs site, notably without the contents of the wall calendar because it can't find the contents yml. If you move it to the root of docs, it works.

https://andrew.quarto.pub/course-website-ejs-docs/