Skip to content

Update Documention - #189

Merged
justinschwerdtfeger merged 35 commits into
dev-docsfrom
yogeb-dev-docs
Sep 10, 2026
Merged

justinschwerdtfeger merged 35 commits into
dev-docsfrom
yogeb-dev-docs

Conversation

@Yogeb-tech

@Yogeb-tech Yogeb-tech commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

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

@Yogeb-tech
Yogeb-tech requested review from a team as code owners September 5, 2026 15:09
@justinschwerdtfeger

Copy link
Copy Markdown
Contributor

I plan on looking over Sunday

@justinschwerdtfeger justinschwerdtfeger left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread docs/Docker-Guide.md Outdated
Comment thread docs/How-to-Contribute.md Outdated
Comment thread docs/How-to-Contribute.md Outdated
Comment thread docs/How-to-Contribute.md Outdated
Comment thread docs/How-to-Contribute.md Outdated
Comment thread docs/Project-Architecture.md Outdated
Comment thread docs/Project-Architecture.md Outdated
Comment thread docs/Project-Architecture.md Outdated
Comment thread docs/Project-Architecture.md Outdated
Comment thread docs/Project-Structure.md
@Yogeb-tech

Copy link
Copy Markdown
Contributor Author

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.

@justinschwerdtfeger

Copy link
Copy Markdown
Contributor

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 justinschwerdtfeger left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a couple of small tweaks

Comment thread docs/Project-Architecture.md Outdated
Comment thread docs/Project-Structure.md Outdated
Comment thread docs/Project-Architecture.md Outdated
Comment thread docs/Project-Architecture.md Outdated
Comment thread docs/Project-Architecture.md Outdated
@Yogeb-tech

Copy link
Copy Markdown
Contributor Author

I've addressed all of the tweaks except for the conversations that are unresolved
(adding libraries section to project-architecture.md)

@justinschwerdtfeger
justinschwerdtfeger marked this pull request as draft September 9, 2026 21:22
@justinschwerdtfeger

Copy link
Copy Markdown
Contributor

I can't request you for a review, but @Yogeb-tech can you review my changes?

@Yogeb-tech

Copy link
Copy Markdown
Contributor Author

@justinschwerdtfeger rewrite is done :)

@justinschwerdtfeger
justinschwerdtfeger marked this pull request as ready for review September 10, 2026 18:54
@justinschwerdtfeger
justinschwerdtfeger dismissed their stale review September 10, 2026 18:58

changes are done

@justinschwerdtfeger

Copy link
Copy Markdown
Contributor

I accidnetally pushed a large 45 mb file that contains scrapped data. this is very large and shouldnt be here, I will force push to fix it

@Yogeb-tech Yogeb-tech left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good, I agree with the language changes

@justinschwerdtfeger
justinschwerdtfeger removed this pull request from stack #190 September 10, 2026 20:14
@justinschwerdtfeger
justinschwerdtfeger merged commit b879008 into dev-docs Sep 10, 2026
2 checks passed
@justinschwerdtfeger
justinschwerdtfeger deleted the yogeb-dev-docs branch September 10, 2026 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants