Currently, all the user-facing documentation is in the root README of the repo. This is good enough for v0 release, but I'd like something more comprehensive for v1.
Ideally, we would have a separate site for documentation about rules_prerender, as I would prefer if README's and docs in the GitHub repo were internal documentation only, not intended to be user facing. The separate documentation site should provide everything users need to know and any information explicitly covered in the API contract.
This also serves as a good test case for rules_prerender, as documentation sites generally work well with a static site generator model, as they don't change frequently and don't rely on prerendering user data. This can act as a real-world use case of rules_prerender.
Currently, all the user-facing documentation is in the root README of the repo. This is good enough for v0 release, but I'd like something more comprehensive for v1.
Ideally, we would have a separate site for documentation about
rules_prerender, as I would prefer if README's and docs in the GitHub repo were internal documentation only, not intended to be user facing. The separate documentation site should provide everything users need to know and any information explicitly covered in the API contract.This also serves as a good test case for
rules_prerender, as documentation sites generally work well with a static site generator model, as they don't change frequently and don't rely on prerendering user data. This can act as a real-world use case ofrules_prerender.