Doxray is a light-weight comment-parser, that transforms YAML into json
Eleventy is a flexible static-site generator that can build out pages based on that json, and also grow to include any other site content we want
Currently I have them built together in a proof-of-concept at [mirisuzanne/remedocs]
(https://github.com/mirisuzanne/remedocs) (not a final home for it). I think this will work well for us, but there are a few issues still to solve:
[x] Should the doxray compilation happen inside the cssremedy repo? That would allow us to run CI tests on the doc step before merging changes, and also create a single access point for the static file to load all necessary data. Alternately, it might be nice to keep all the doc build steps outside of this repo. UPDATE: planning to keep the entire build-step inside remedocs for now.
[ ] Once the cssremedy package is released, I'll need to setup the build step for importing the remedy files (or pre-compiled docs file) into remedocs. That should be straight-forward.
[ ] We should move remedocs to… the mozdevs org here on github? We could potentially deploy to gh-pages, or use Netlify to set up a more automated build cycle.
(I'd also love if we could use something more clear than /* doxray to mark documentation comments, so I opened an issue over there… We'll see…)
Issues:
Closes #58
Closes #53 once we get it done…
Improvements on #7 I think, but not ready to close…
Currently I have them built together in a proof-of-concept at [mirisuzanne/remedocs] (https://github.com/mirisuzanne/remedocs) (not a final home for it). I think this will work well for us, but there are a few issues still to solve:
cssremedyrepo? That would allow us to run CI tests on the doc step before merging changes, and also create a single access point for the static file to load all necessary data. Alternately, it might be nice to keep all the doc build steps outside of this repo. UPDATE: planning to keep the entire build-step inside remedocs for now.cssremedypackage is released, I'll need to setup the build step for importing the remedy files (or pre-compiled docs file) into remedocs. That should be straight-forward.mozdevsorg here on github? We could potentially deploy to gh-pages, or use Netlify to set up a more automated build cycle.(I'd also love if we could use something more clear than
/* doxrayto mark documentation comments, so I opened an issue over there… We'll see…)Issues: