Docs and Guides

Question

leandrocp opened this issue 5 months ago · comments

Meta issue to track all the work necessary on docs and guides for v0.1

Beacon

CHANGELOG
#473
#474
Update ex_doc
Update the installation guide to fix and improve it based on feedback received
Update the "your first site" guide to fix and improve it based on feedback received
Review groups - modules may have been added or removed or are now @moduledoc false
Review module docs - it's not viable to document all the ~100 files we have at this moment so we need to add @moduledoc false to private modules or modules that do not impact users. Others we need to review module and functions docs adding a summary, examples, and notes.
Review and add missing @spec to public functions, eg: Content, MediaLibrary - only in the main API (main modules)
Review Beacon docs
~~List all authz operations available~~ (removed)
Write a "publish a blog" recipe that calls Content.list_published_pages/2 to list most recent pages and filter by tag
Write a quick guide showing the usage of beacon assigns, ie: calling @beacon in templates to access data like site name, path/query params, etc.
Brainstorm other guides that makes sense to write for v0.1