Skip to content

Commit 4016bed

Browse files
author
José Valim
committed
Provide a reference to other docs on Phoenix module
1 parent 2d078eb commit 4016bed

File tree

4 files changed

+31
-5
lines changed

4 files changed

+31
-5
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
/_build
22
/deps
3+
/doc
34
/tmp
45
/node_modules
56

67
/installer/_build
78
/installer/tmp
89

9-
erl_crash.dump
10+
erl_crash.dump

lib/phoenix.ex

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,29 @@
11
defmodule Phoenix do
2+
@moduledoc """
3+
This is documentation for the Phoenix project.
4+
5+
By default, Phoenix applications depend on other packages besides
6+
Phoenix itself. Below we provide a short explanation with links to
7+
their documentation for each of those projects:
8+
9+
* [Ecto](http://hexdocs.pm/ecto) - a language integrated query and
10+
database wrapper
11+
12+
* [Phoenix](http://hexdocs.pm/phoenix) - the Phoenix web framework
13+
(these docs)
14+
15+
* [Phoenix HTML](http://hexdocs.pm/phoenix_html) - conveniences for
16+
working with HTML in Phoenix
17+
18+
* [Plug](http://hexdocs.pm/plug) - a specification and conveniences
19+
for composable modules in between web applications
20+
21+
There are also optional packages depending on your configuration:
22+
23+
* [Phoenix PubSub Redis](http://hexdocs.pm/phoenix_live_reload) - use
24+
Redis to power Phoenix PubSub system
25+
26+
"""
227
use Application
328

429
@doc false

mix.exs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ defmodule Phoenix.Mixfile do
99
elixir: "~> 1.0.2 or ~> 1.1-dev",
1010
deps: deps,
1111
package: package,
12-
docs: [source_ref: "v#{@version}", main: "overview"],
12+
docs: [source_ref: "v#{@version}", main: "Phoenix"],
1313
name: "Phoenix",
1414
source_url: "https://github.com/phoenixframework/phoenix",
1515
homepage_url: "http://www.phoenixframework.org",

mix.lock

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
%{"cowboy": {:hex, :cowboy, "1.0.0"},
22
"cowlib": {:hex, :cowlib, "1.0.1"},
3-
"earmark": {:hex, :earmark, "0.1.10"},
4-
"ex_doc": {:hex, :ex_doc, "0.7.1"},
3+
"earmark": {:hex, :earmark, "0.1.17"},
4+
"ex_doc": {:hex, :ex_doc, "0.7.3"},
55
"inch_ex": {:hex, :inch_ex, "0.2.3"},
66
"phoenix_html": {:hex, :phoenix_html, "1.2.0"},
77
"plug": {:hex, :plug, "0.13.0"},
88
"poison": {:hex, :poison, "1.3.0"},
99
"poolboy": {:hex, :poolboy, "1.5.1"},
1010
"ranch": {:hex, :ranch, "1.0.0"},
1111
"redo": {:git, "git://github.com/heroku/redo.git", "b25e7bd3b197564192069d609d1e8e02183b71a6", []},
12-
"websocket_client": {:git, "git://github.com/jeremyong/websocket_client.git", "48c118682292f2e4d80491161134a665525c4934", []}}
12+
"websocket_client": {:git, "https://github.com/jeremyong/websocket_client.git", "48c118682292f2e4d80491161134a665525c4934", []}}

0 commit comments

Comments
 (0)