Revamp docs #15
Merged
Revamp docs #15
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
emkguts
force-pushed
the
revamp-docs
branch
2 times, most recently
from
5fb3f4e to
983ad19
Compare
kybishop
approved these changes
Feb 7, 2025
jjcarstens
requested changes
Feb 7, 2025
There was a problem hiding this comment.
This doesn't generate docs for me.
Generating docs...
warning: documentation references file "LICENSE" but it does not exist
└─ README.md: (file)
08:35:23.778 [error] Task #PID<0.2922.0> started from #PID<0.94.0> terminating
** (File.Error) could not read file "docs/credo.md": no such file or directory
(elixir 1.18.1) lib/file.ex:385: File.read!/1
(ex_doc 0.34.2) lib/ex_doc/formatter/html.ex:411: ExDoc.Formatter.HTML.build_extra/5
(elixir 1.18.1) lib/task/supervised.ex:101: Task.Supervised.invoke_mfa/2
(elixir 1.18.1) lib/task/supervised.ex:36: Task.Supervised.reply/4
Function: &:erlang.apply/2
Args: [#Function<0.90559089/1 in ExDoc.Formatter.HTML.build_extras/2>, ["docs/credo.md": [title: "Quokka & Credo"]]]
** (EXIT from #PID<0.94.0>) an exception was raised:
** (File.Error) could not read file "docs/credo.md": no such file or directory
(elixir 1.18.1) lib/file.ex:385: File.read!/1
(ex_doc 0.34.2) lib/ex_doc/formatter/html.ex:411: ExDoc.Formatter.HTML.build_extra/5
(elixir 1.18.1) lib/task/supervised.ex:101: Task.Supervised.invoke_mfa/2
(elixir 1.18.1) lib/task/supervised.ex:36: Task.Supervised.reply/4
|
can be removed from here: https://github.com/smartrent/quokka/blob/main/mix.exs#L73 |
The recommended ExDoc way to reference and link modules is by using backticks. This adds those to all Credo module links to ensure they render as a module link despite being a hardcoded hexdoc link (vs auto-linking)
* Make the warning pronounced and at the top * install and config before rewrites section * Format config options into a table * Fix description for `inefficient_function_rewrites`
jjcarstens
approved these changes
Feb 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.