Describe indexer structure and list existing fetchers #1763
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
Resolves #1628. A brief description of indexer structure is added to `README.md` of `indexer` application. Installation instructions are removed, as they don't make sense for sub-app of umbrella application.
ghost
assigned 
Pull Request Test Coverage Report for Build e4eb5f55-b332-469e-a9a0-5c62fcd6e6de
💛 - Coveralls |
ayrat555
reviewed
Apr 16, 2019
| 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/indexer](https://hexdocs.pm/indexer). | ||
| ## Structure |
There was a problem hiding this comment.
Maybe we can move this to some other markdown file? Because Readme is meant to be an introduction to the project. This is some advanced stuff and it requires a knowledge of Elixir which most of our users don't possess.
There was a problem hiding this comment.
I think moduledoc is the best place to put it.
There was a problem hiding this comment.
We have README.md in the root directory and each of the sub-apps.
I think that most users won't ever go past the root one, so it should contain instructions for them.
But if you actually go to read about a sub-app, you probably are already interested enough in how the app is structured, so it's a good place to put such description there.
Moreover, the only way to adequately read moduledoc is compiling code documentation, which is not even done in our CI.
ayrat555
approved these changes
Apr 16, 2019
vbaranov
approved these changes
Apr 16, 2019
saneery
approved these changes
Apr 16, 2019
gabitoesmiapodo
added a commit
that referenced
this pull request
Apr 16, 2019
* master: (25 commits) Describe indexer structure and list existing fetchers (#1763) add more test cases fix CR issues add CHANGELOG entry do not hardcode values in tests fix credo add CHANGELOG entry add today's token balance from previous value add CHANGELOG entry fix gettext add label change package version download chrom directly fix command order fix script try using chrome headless for wallaby fix failing test update phantom js on circle ci bumbp cache version fix gettext ... # Conflicts: # apps/block_scout_web/priv/gettext/default.pot # apps/block_scout_web/priv/gettext/en/LC_MESSAGES/default.po
gabitoesmiapodo
added a commit
that referenced
this pull request
Apr 16, 2019
#1638-new-style-for-lukso-network * feature/#1476-add-styles-for-POSDAO-network: (25 commits) Describe indexer structure and list existing fetchers (#1763) add more test cases fix CR issues add CHANGELOG entry do not hardcode values in tests fix credo add CHANGELOG entry add today's token balance from previous value add CHANGELOG entry fix gettext add label change package version download chrom directly fix command order fix script try using chrome headless for wallaby fix failing test update phantom js on circle ci bumbp cache version fix gettext ... # Conflicts: # apps/block_scout_web/priv/gettext/default.pot # apps/block_scout_web/priv/gettext/en/LC_MESSAGES/default.po
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.
Resolves #1628.
A brief description of indexer structure is added to
README.mdofindexerapplication.Installation instructions are removed, as they don't make sense for sub-app of umbrella application.
Checklist for your PR
CHANGELOG.mdwith this PR