Skip to content

Commit

Permalink
docs: docs overhaul
Browse files Browse the repository at this point in the history
  • Loading branch information
zachdaniel committed May 4, 2024
1 parent 90efcb5 commit 8ec942c
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 22 deletions.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
![Elixir CI](https://github.com/ash-project/ash_csv/workflows/Ash%20CI/badge.svg)
![Logo](https://github.com/ash-project/ash/blob/main/logos/cropped-for-header-black-text.png?raw=true#gh-light-mode-only)
![Logo](https://github.com/ash-project/ash/blob/main/logos/cropped-for-header-white-text.png?raw=true#gh-dark-mode-only)

![Elixir CI](https://github.com/ash-project/ash_csv/workflows/CI/badge.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Hex version badge](https://img.shields.io/hexpm/v/ash_csv.svg)](https://hex.pm/packages/ash_csv)
[![Hexdocs badge](https://img.shields.io/badge/docs-hexdocs-purple)](https://hexdocs.pm/ash_csv)

# AshCsv

A CSV data layer for Ash.
Welcome! This is the CSV Data Layer for [Ash Framework](https://hexdocs.pm/ash).

## Tutorials

## Installation
- [Getting Started with GraphQL](documentation/tutorials/getting-started-with-ash-csv.md)

```elixir
def deps do
[
{:ash_csv, "~> 0.9.7-rc.0"}
]
end
```
## Reference

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/ash_csv](https://hexdocs.pm/ash_csv).
- [AshCsv.DataLayer DSL](documentation/dsls/DSL:-AshCsv.DataLayer.md)
2 changes: 1 addition & 1 deletion config/config.exs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ if Mix.env() == :dev do
manage_mix_version?: true,
# Instructs the tool to manage the version in your README.md
# Pass in `true` to use `"README.md"` or a string to customize
manage_readme_version: "README.md",
manage_readme_version: ["README.md", "documentation/tutorials/getting-started-with-csv.md"],
version_tag_prefix: "v"
end
5 changes: 0 additions & 5 deletions documentation/tutorials/get-started-with-csv.md

This file was deleted.

13 changes: 13 additions & 0 deletions documentation/tutorials/getting-started-with-ash-csv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Getting Started with CSV

AshCsv offers basic support for storing and reading resources from csv files.

## Installation

Add `ash_csv` to your list of dependencies in `mix.exs`:

```elixir
{:ash_csv, "~> 0.9.7-rc.0"}
```

For information on how to configure it, see the [DSL documentation.](/documentation/dsls/DSL:-AshCsv.DataLayer.md)
7 changes: 4 additions & 3 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ defmodule AshCsv.MixProject do

@version "0.9.7-rc.0"

@description "A CSV data layer for Ash"
@description "The CSV data layer for Ash Framework"

def project do
[
Expand Down Expand Up @@ -31,7 +31,7 @@ defmodule AshCsv.MixProject do

defp docs do
[
main: "get-started-with-csv",
main: "readme",
source_ref: "v#{@version}",
before_closing_head_tag: fn type ->
if type == :html do
Expand All @@ -49,7 +49,8 @@ defmodule AshCsv.MixProject do
end
end,
extras: [
"documentation/tutorials/get-started-with-csv.md",
{"README.md", title: "Home"},
"documentation/tutorials/getting-started-with-ash-csv.md",
"documentation/dsls/DSL:-AshCsv.DataLayer.md"
],
groups_for_extras: [
Expand Down

0 comments on commit 8ec942c

Please sign in to comment.