A few Ruby/Rails-aligned documentation sites I'll mention:

• StimulusReflex
• Jumpstart
• Bridgetown (full disclosure — I work on this one)

@jaredcwhite those are all fantastic examples!

I'm really impressed with the Bridgetown site. Would you be up for helping out with this project?

@joelhawksley Well, if you don't mind using Bridgetown rather than Jekyll, I think it'd be pretty easy to clone the BT site and clear out the content and tweak the design for use here. You should be able to use GH actions to run the build process and deploy on pages here… slightly more inconvenient than using Jekyll directly, but not by a ton. (Bonus: you get Webpack for front-end assets as well that way…) Anyway, I could help out with all that if need be.

@joelhawksley I really like how things are organized using the gitbook + github integration. I created a documentation reorganizing some subjects by sessions. So, if it looks good, I can open a PR with the gitbook MD files.
https://g13ydson.gitbook.io/view-component-docs

I'm happy to help out writing any guides or docs!

PS: Love the gitbook site @g13ydson !

@g13ydson very cool! Would we still be able to host this on GitHub pages?

@joelhawksley with gitbook it is possible, but it takes more work. I decided to create with Jekyll. #529
DEMO: https://g13ydson.github.io/view_component_doc/

In https://www.youtube.com/watch?v=EQoJVFgZXo4, @maxshelley gave our docs a thorough read as a developer new to the project ❤️

Here are some improvements I think we should look into making based on his experience:

• Add more detail regarding the form_for workaround. I think we can direct folks towards using the _tag helpers for now.
• Provide a better example application experience than view-component-demo, which is out of date and lacks documentation.
• Add documentation for the monkey patch.
• Add a brief explanation for why ViewComponent is faster than partials.
• Clarify that content is set by passing in a block, and doesn't need to be an argument in the component initializer.
• Add documentation on how to generate a sidecar folder with the generator.
• Clarify that render? is for whether the entire component is rendered or not.
• Find a better way to explain what is accessible from the component template (instance variables and methods on the component object).