Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add inline template documentation #16

Open
paltman opened this issue Oct 18, 2017 · 1 comment
Open

Add inline template documentation #16

paltman opened this issue Oct 18, 2017 · 1 comment

Comments

@paltman
Copy link
Contributor

paltman commented Oct 18, 2017

EIther do this as one pass for break this up for each app, but the idea is we should design the pages in a way where you can view the template for styling but also be able to view the documentation for the template.

Template documentation should be pretty easy to generate as its very formulaic in that it's really just documenting the context variables, template name, and any blocks available to override.

Perhaps some form of tabbed interface for each template. The default is a preview but then a tab or other link were you can reveal the docs. Maybe the documentation can be represented well in a 300-600px column and if that's the case can provide a right-hand pop-out like the proposed left-hand pop-out menu in #15.

We would then need to codify the documentation as part of the configuration.

@paltman
Copy link
Contributor Author

paltman commented Oct 28, 2017

Things to document:

  • context variables
  • blocks available to override (typical pattern would be overriding, not extending the template)
  • make the source of the template available for easy reference on structure for styling

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant