Skip to content

Commit d631af4

Browse files
committed
fix: doc issues
1 parent 33d395a commit d631af4

File tree

4 files changed

+20
-18
lines changed

4 files changed

+20
-18
lines changed

docs/overview.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ ErrorMessage is a library designed to simplify error handling in Elixir applicat
1212

1313
## Documentation Structure
1414

15-
This documentation follows the [Diátaxis framework](https://diataxis.fr/), which organizes documentation into four distinct types:
16-
1715
1. **Tutorials**: Step-by-step lessons to help you get started with ErrorMessage
1816
2. **How-To Guides**: Practical guides for solving specific problems
1917
3. **Explanation**: Conceptual discussions about ErrorMessage's design and principles

docs/reference/serialization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ If a request ID is available in the Logger metadata, it will be included:
6363

6464
### Data Type Handling
6565

66-
The `ErrorMessage.Serializer` module includes the `ensure_json_serializable/1` function, which handles conversion of Elixir-specific data types to JSON-compatible formats:
66+
The ErrorMessage.Serializer module includes the `ensure_json_serializable/1` function, which handles conversion of Elixir-specific data types to JSON-compatible formats:
6767

6868
| Elixir Type | JSON Representation |
6969
|-------------|---------------------|

docs/tutorials/getting_started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,8 @@ end
118118

119119
Now that you understand the basics of ErrorMessage, you can:
120120

121-
- Check out the [How-To Guides](/docs/how-to-guides/) for practical examples
122-
- Explore the [Explanation](/docs/explanation/) section to understand the design principles
123-
- Refer to the [API Reference](/api-reference.html) for detailed function documentation
121+
- Check out the [How-To Guides](https://hexdocs.pm/error_message/how-to-guides.html) for practical examples
122+
- Explore the [Explanation](https://hexdocs.pm/error_message/explanation.html) section to understand the design principles
123+
- Refer to the [API Reference](https://hexdocs.pm/error_message/api-reference.html) for detailed function documentation
124124

125125
Congratulations! You've completed the getting started tutorial for ErrorMessage.

mix.exs

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ defmodule ErrorMessage.MixProject do
4343
{:credo, "~> 1.6", only: [:test, :dev], runtime: false},
4444
{:blitz_credo_checks, "~> 0.1", only: [:test, :dev], runtime: false},
4545

46-
{:excoveralls, "~> 0.10", only: :test},
47-
{:ex_doc, ">= 0.0.0", optional: true, only: :dev},
46+
{:excoveralls, "~> 0.10", only: :test, runtime: false},
47+
{:ex_doc, ">= 0.0.0", optional: true, only: :dev, runtime: false},
4848
{:dialyxir, "~> 1.0", optional: true, only: :test, runtime: false}
4949
]
5050
end
@@ -54,7 +54,7 @@ defmodule ErrorMessage.MixProject do
5454
maintainers: ["Mika Kalathil"],
5555
licenses: ["MIT"],
5656
links: %{"GitHub" => "https://github.com/MikaAK/elixir_error_message"},
57-
files: ~w(mix.exs README.md CHANGELOG.md lib)
57+
files: ~w(mix.exs README.md CHANGELOG.md lib docs)
5858
]
5959
end
6060

@@ -65,20 +65,24 @@ defmodule ErrorMessage.MixProject do
6565
extra_section: "DOCUMENTATION",
6666
extras: [
6767
"docs/overview.md",
68+
"docs/how-to-guides/error_handling_patterns.md",
69+
"docs/how-to-guides/phoenix_integration.md",
70+
"docs/explanation/error_design_principles.md",
71+
"docs/explanation/error_handling_in_elixir.md",
72+
"docs/reference/api_reference.md",
73+
"docs/reference/serialization.md",
74+
"docs/tutorials/error_handling_workflow.md",
75+
"docs/tutorials/getting_started.md",
6876
"CHANGELOG.md"
6977
],
7078
groups_for_extras: [
71-
"Guides": [
72-
"docs/overview.md",
73-
],
74-
"Tutorials": Path.wildcard("docs/tutorials/*.md"),
75-
"How-To Guides": Path.wildcard("docs/how-to-guides/*.md"),
76-
"Explanation": Path.wildcard("docs/explanation/*.md"),
77-
"Reference": Path.wildcard("docs/reference/*.md")
79+
Tutorials: ~r/docs\/tutorials\/.?/,
80+
"HowTo docs": ~r/docs\/how-to-guides\/.?/,
81+
Reference: ~r/docs\/reference\/.?/,
82+
Explanation: ~r/docs\/explanation\/.?/
7883
],
7984
groups_for_modules: [
80-
"Core": [ErrorMessage],
81-
"Serialization": [ErrorMessage.Serializer]
85+
"Core": [ErrorMessage]
8286
]
8387
]
8488
end

0 commit comments

Comments
 (0)