Missing docs?

[petrenkorf]

Hey @spohlenz

I'm willing to help with the project, and actually I've been missing a detailed documentation about the resources. Do you have any example files to send to me so I can make a PR with docs?

[aleksclark]

Should the docs just go in the wiki? I've started adding to the Form Fields page just so my team has a handy reference. You could probably just start with documenting the stuff in the RubyFlix demo project.

[spohlenz]

I think that, for the short term, the wiki is a good place for docs, and I appreciate any help in contributing, major or minor. At the very least, this will give me a good basis for the types of things I need to cover in the main documentation (which I am working on but have had some false starts).

I have some contracts finishing up in the next couple of weeks after which I'll finally be able to give Trestle and the docs some much needed attention.

[tcd]

@spohlenz Has any work been made on documentation outside of the Wiki? I'm interested in helping out with docs; I just wanted to make sure I'm not redoing any work that's already been done :) Also, thank you for the awesome project!

[zealot128]

Found Trestle recently and was initially drawn by a BS4 theme with a ActiveAdmin like config, but more flexibility and less problematic dependencies. But now I am more and more impressed what kind of configuration/features are already there, if one scans the issues or reads the code. IMO it's a big hurdle for adoption (not sure that's a goal anyways, maybe getting too popular is also a bane) that it's missing a comprehensive general documentation beyond trestle.io + a couple of wiki pages.

I also could help out documenting stuff. Is it possible to opensource "trestle.io" which I guess is a jekyll or alike SSG.

Sections/subpages from the top of my head:

• resourceless pages (Trestle.admin(..)) + routes + controller + boilerplate for views (header + .main-content-area + ..)
• Menu / Groups, priority, fa-icons
• Index Page
  • table do,
  • paginate(per: 100)
  • scopes + scope groups
  • collection: preloading, default sort
  • adding filters: trestle-search
  • remove_actions, making a readonly view example (no delete, no edit, but implementing a show page?)
  • sort_column
  • column options: link: false, sort:, block, ...
• User logins: trestle-auth / devise / customization
• form:
  • sidebar
  • auto
  • tabs
  • form_fields wiki page + argument descriptions (label, help -> hint)
  • examples on including custom html (e.g. i used concat(tag.div { "Some custom content" }) or render partial:
  • active-storage integration (trestle-plugin linking)
  • addons: tinymce + jsoneditor linking (very useful)
• custom actions (wiki article already there)
• adding webpacker/custom css + js (config.hook(:stylesheets) { stylesheet_pack_tag "admin" ..)