sodapopcan
Hologram documentation feedback
Hey Bart and all,
I’m not sure if this has been talked about before (I’ve looked but of course I could have missed it) but one of my biggest pain points with working with Hologram is that the full documentation doesn’t live in hexdocs. This is not a dig at the website, it’s fine and works and I can find what I need, but it would be so much more convenient if it lived in hexdocs. It’s familiar, I can search it, I can use h in IEx, and it can be used with tools like Dash. The other big thing is that the Hologram website is in a private repo making contributing to documentation quite hard. It has occurred to me that perhaps this is by design for the moment so you don’t get flooded with PRs?
In any event, how do you all feel? Also, @bartblast, is Elixir Forum the right place for this kind of feedback? Wasn’t sure if I should have opened and issue first.
Marked As Solved
bartblast
Hey Andrew, totally fair feedback!
I actually addressed this in detail some time ago - check out this post: Hologram Documentation Updates/Feedback - #21 by bartblast
TLDR: The Hologram website is meant to evolve into an interactive educational platform - think component playgrounds (like Storybook), real-time demos, community showcases, AI-powered assistance deeply integrated with framework internals, and more. HexDocs would either make some of these impossible or constantly get in the way. The site is also built with Hologram itself, which is valuable for dogfooding and as a real-world showcase of the framework.
That said, nothing prevents us from adding the features you like about HexDocs - search, Dash compatibility - to our own docs. Those are on the radar. Dash support is definitely doable with a custom site, and this kind of thing would be a great area for community contributions eventually. As for h in IEx - that actually already works for Hologram since every public function is documented with @doc. There’s also an API reference on HexDocs: https://hexdocs.pm/hologram
As for contributing to docs - I do plan to make it possible to suggest edits directly from the website. There are a few things I need to build first though, like a macro component feature, before that can happen.
And yes, Elixir Forum is a perfectly fine place for this kind of feedback!
Popular in Discussions
Other popular topics
Latest Hologram Threads
Latest on Elixir Forum
Sponsor Spotlight
Enabling companies to succeed by building software people love.
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #phoenix_html
- #iex
- #blog-post
- #graphql
- #genstage
- #ai
- #websockets
- #supervisor
- #advent-of-code
- #elixirconf-us
- #distillery
- #processes
- #forms
- #api
- #metaprogramming
- #security
- #performance
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Error tracking for Elixir devs who love to ship. Start your free account.
Practical resources that improve the lives of professional developers.
Develop your skills with books, videos, and courses.
The deployment platform built for Elixir: PaaS ease, VPS control.
The team behind Membrane, Popcorn, LiveDebugger. Available for hire.
Courses that'll move you from confusion to "Aha, now I get it!"