Skip to content

Commit

Permalink
Misc doc changes (#27)
Browse files Browse the repository at this point in the history
List of changes:
- bump elixir/erlang version in asdf
- add missing docs to final html output
- fix incorrect license file link in readme
  • Loading branch information
kianmeng authored Jan 18, 2024
1 parent 514710b commit d45586a
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 11 deletions.
4 changes: 2 additions & 2 deletions .tool-versions
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
elixir 1.14.3
erlang 25.2
elixir 1.15.7-otp-26
erlang 26.1.2
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to Uinta
# Contributing to Graphql Markdown

Please take a moment to review this document in order to make the contribution
process easy and effective for everyone involved!
Expand Down Expand Up @@ -118,13 +118,13 @@ in order to craft an excellent pull request:

```bash
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/uinta
git clone https://github.com/<your-username>/graphql_markdown

# Navigate to the newly cloned directory
cd uinta

# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/podium/uinta
git remote add upstream https://github.com/podium/graphql_markdown
```

2. If you cloned a while ago, get the latest changes from upstream, and update your fork:
Expand Down
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,15 @@ end

And run:

$ mix deps.get
```shell
mix deps.get
```

# will create a single file called graphql_schema.md in the current dir
$ mix graphql_gen_markdown -f ./schema.json
Generate a single file called `graphql_schema.md` in the current dir:

```shell
mix graphql_gen_markdown -f ./schema.json
```


Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
Expand Down Expand Up @@ -96,7 +101,7 @@ defmodule Azeroth.MixProject do

Make sure the absinthe schema is specified or generated with that name. Or add to your config.exs:

```
```elixir
config :absinthe, schema: YouApp.GraphQL.Schema
```

Expand All @@ -118,4 +123,4 @@ Emmanuel Pinault (@epinault)

## License

GraphqlMarkdown is released under the MIT License. See the LICENSE file for further details.
GraphqlMarkdown is released under the MIT License. See the [LICENSE.md](LICENSE.md) file for further details.
5 changes: 4 additions & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,11 @@ defmodule GraphqlMarkdown.MixProject do
[
main: "readme",
extras: [
"CHANGELOG.md",
{:"README.md", title: "Readme"},
"CHANGELOG.md"
{:"LICENSE.md", title: "License"},
{:"CONTRIBUTING.md", title: "Contributing"},
"CODE_OF_CONDUCT.md"
],
source_url: @project_url,
source_ref: "v#{@version}",
Expand Down

0 comments on commit d45586a

Please sign in to comment.