mirror of
https://github.com/ash-project/ash.git
synced 2024-09-20 13:33:20 +12:00
docs: more work on doc replacements/info
This commit is contained in:
parent
b0e58ab57d
commit
ff890e4654
2 changed files with 37 additions and 1 deletions
|
@ -1,5 +1,16 @@
|
||||||
# Quick Start
|
# Quick Start
|
||||||
|
|
||||||
|
### NOTICE
|
||||||
|
|
||||||
|
This guide is old, and will be replaced soon. Once the generators are done. At that point, the quick start will look something like
|
||||||
|
|
||||||
|
- `mix new app_name` or `mix phx.new app_name`
|
||||||
|
- Add the ash dependency `{{dep:ash}}`
|
||||||
|
- Add the
|
||||||
|
|
||||||
|
## Start Here
|
||||||
|
|
||||||
|
|
||||||
The first step is to decide if you're building a phoenix application or not. Phoenix is an extremely high quality web framework, and is the suggested pairing with Ash if you expect to be building a web front end, or an API. For this guide, we assume that elixir has already been installed. We will be using a "helpdesk" example throughout the documentation, so if you want to play along with your own application, you'll need to replace various names.
|
The first step is to decide if you're building a phoenix application or not. Phoenix is an extremely high quality web framework, and is the suggested pairing with Ash if you expect to be building a web front end, or an API. For this guide, we assume that elixir has already been installed. We will be using a "helpdesk" example throughout the documentation, so if you want to play along with your own application, you'll need to replace various names.
|
||||||
|
|
||||||
## Installing With Phoenix
|
## Installing With Phoenix
|
||||||
|
|
|
@ -1,6 +1,31 @@
|
||||||
defmodule Ash.DocIndex do
|
defmodule Ash.DocIndex do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
A module for configuring how a library is rendered in ash_hq
|
A module for configuring how a library is rendered in ash_hq.
|
||||||
|
|
||||||
|
There is a small template syntax available in any documentation.
|
||||||
|
The template syntax will link to the user's currently selected
|
||||||
|
version for the relevant library.
|
||||||
|
|
||||||
|
All templates should be wrapped in double curly braces, e.g `{{}}`. This is not done here
|
||||||
|
as it would be replaced in the very documentation you are reading.
|
||||||
|
|
||||||
|
## Links to other documentation
|
||||||
|
|
||||||
|
`link:library:item_type:name`
|
||||||
|
|
||||||
|
The only item_type currently supported is `guide`, so the name would be `category/name`
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
`link:ash:guide:Topics/Attributes` -> `-> `<a href="/docs/guides/ash/topics/attributes.md">Attributes</a>`
|
||||||
|
|
||||||
|
## Mix dependencies
|
||||||
|
|
||||||
|
`mix_dep:library`
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
`mix_dep:ash` -> `{:ash, "~> 1.5"}`
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@type extension :: %{
|
@type extension :: %{
|
||||||
|
|
Loading…
Reference in a new issue