103 change readme composition and add more information about running #164
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
asgibson
force-pushed
the
103-change-readme-composition-and-add-more-information-about-running
branch
from
3c50838 to
2794fc4
Compare
the-other-james
requested changes
Nov 13, 2024
README Removed options from enviroment set up, now only provide local pip install directions. Edited some text for clarity. Made default_config.ini link the permalink. Completely reworked the next steps section. Architecture Updated and expanded initial paragraph at top. Added Data source sections. Added flow to pipeline. Made file outlines into tables. CSV parser section filled out. Unfinished sections marked as such. Provided example for the pipeline data. Changed low and high level data definitions. Fixed render_reasoning output text (a dict is not required to be returned). Added flow diagram. Added more output for the reporter plugin example.
asgibson
force-pushed
the
103-change-readme-composition-and-add-more-information-about-running
branch
from
fd829f3 to
7bdf5bb
Compare
the-other-james
requested changes
Nov 18, 2024
Moved images directory into doc directory Landing page README Added supported python versions badge Added black code style badge Moved logo to doc/images Separate lines for sentences in same paragraph Moved optional for step 3 (unit test run) to top of step Fixed links Removed unnecessary Contact section Architecture Separate lines for each sentence in paragraph Changed and made consistent 'Telemetry Definintion File' Fixed links Expanded and clarified high_level_data definition Flow section redone for clarity and ease of use Doc section README Fixed logo image location
the-other-james
approved these changes
Nov 20, 2024
|
Allowing this to be merged even though Architecture page is not 100% finished. |
asgibson
deleted the
103-change-readme-composition-and-add-more-information-about-running
branch
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.
Updates. Not yet complete, requesting comments.