Update Documention - #189
Conversation
|
I plan on looking over Sunday |
justinschwerdtfeger
left a comment
justinschwerdtfeger
left a comment
There was a problem hiding this comment.
Overall, looks very good, and I appreciate lots of areas you made the docs more concise (including what I wrote).
I made some suggestions, let me know what you think and if you agree
I'll definitely need to make some changes of my own to Docker-Guide.md and Troubleshooting.md, and README.md
| - **External Resources**: | ||
| - [Bash Scripting Tutorial for Beginners](https://linuxconfig.org/bash-scripting-tutorial-for-beginners) | ||
| - Parse HTML via Go tokenizers and CSS selectors (`golang.org/x/net/html`) | ||
| - Cross-reference scraped data with static datasets (grade CSVs, budget PDFs) |
There was a problem hiding this comment.
I want us to mention more, if not every library we use in this file, for example we should mention goquery and how its useful for parsers.
Not exactly sure how best to lay out this document
There was a problem hiding this comment.
I've tried rewriting the document layout to align with our project structure. For example there are a few higher level resources, and the resources specific to the scraper, parser, etc. Let me know you thoughts on this layout
There was a problem hiding this comment.
I like project-architecture's concise overview, but I think we should add a new section about the libraries
|
I've addressed all of the requested changes. Please see my replies to the specific comments, as there were a few cases where I made a different choice or had some disagreement with the suggested change. |
|
Could add something like api-tools is a collection of tools, many are self contained and can be run from command line following instructions from readme.md |
justinschwerdtfeger
left a comment
justinschwerdtfeger
left a comment
There was a problem hiding this comment.
I left a couple of small tweaks
|
I've addressed all of the tweaks except for the conversations that are unresolved |
|
I can't request you for a review, but @Yogeb-tech can you review my changes? |
I found orchrestration could be replaced with simpler language
|
@justinschwerdtfeger rewrite is done :) |
2 participants
Overall the documentation looks a lot cleaner. However, I'm sure there are improvements I can make overtime until Thursday.
My only difficulty is I do not know of any good video resources for GUIDES.md
Additionally I think it's best if you handled TroubleShooting.md. You have more knowledge of the bugs in api-tools than I do