phoenixframework / phoenix_live_view

Rich, real-time user experiences with server-rendered HTML
https://hex.pm/packages/phoenix_live_view
MIT License
6.12k stars 917 forks source link

Wrong documentation #426

Closed bfcns closed 4 years ago

bfcns commented 4 years ago

[https://github.com/phoenixframework/phoenix_live_view]() documentation shows for master git repository, but in the beginning it has:


def deps do
  [
    {:phoenix_live_view, "~> 0.3.0"},
    {:floki, ">= 0.0.0", only: :test}
  ]
end

Below (_livecomponent) does not work for above setting:


def view do
  quote do
    ...
    import Phoenix.LiveView,
      only: [live_render: 2, live_render: 3, live_link: 1, live_link: 2,
             live_component: 2, live_component: 3, live_component: 4]
  end
end
snewcomer commented 4 years ago

@phpcitizen Until a new release is published with live_component, you can point to a commit sha or master!

https://hexdocs.pm/mix/Mix.Tasks.Deps.html#module-git-options-git

{:phoenix_live_view, git: "git@github.com:phoenixframework/phoenix_live_view.git", branch: "master"}
ityonemo commented 4 years ago

can you include the release's readme as a part of the hexdocs (and maybe also point the readme to hexdocs for versioned installation guides?) This tripped me up for a hot sec just now.

bfcns commented 4 years ago

@snewcomer I am talking about this documentation: https://github.com/phoenixframework/phoenix_live_view

There is a conflict between the start and the end as I mentioned. This can be rectified easily without confusing newcomers.

PragTob commented 4 years ago

README's on github usually reflect the status on master. Including the README in docs might be nice.

Here is a link to the README at the state of the last release: https://github.com/phoenixframework/phoenix_live_view/tree/v0.3.1

DarkMarmot commented 4 years ago

I agree with @ityonemo -- adding the installation instructions that match the current hex version to the hex documentation is a good move. I also encountered this issue.

chrismccord commented 4 years ago

master always reflects the actively developed, unreleased branch. Thanks!