Documentation is outdated.
Problems
- README.md
- Doesn't contain relevant instructions. No information about database migration required after db creation.
- Information about postman collection is outdated and unusable.
- There are no any links to related projects
- Looks like project could be run on it's own, but it shouldn't
- There are no links to instructions about running own Hermes or Atlas node
- introduction.md
- Doesn't contain information about role of this project in abrosus network
- Should contain links to other repos of ambrosus project
- tutorial.md
- code samples doesn't work
- goals are unclear
- dev.ambrosus.io link doesn't work
- ApplicationEntryTypes.md
- goal of this document is unclear
- there are no links to this document, so it's potentially unreachable to regular user
- BasicEventEntryTypes
- there are no links to this document, so it's potentially unreachable to regular user
- Security.md
- Should contain recommendations how to write good vulnerability report
What should be added
- Document code with docstrings
Documentation is outdated.
Problems
What should be added