Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

103 change readme composition and add more information about running #164

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from

Commits on Nov 18, 2024

  1. Configuration menu
    Copy the full SHA
    b4277d7 View commit details
    Browse the repository at this point in the history
  2. Fixes

    Fixed redundant NOTE: in #3
    Shortend second quick start note
    Added color to OnAIR in user guide section
    asgibson committed Nov 18, 2024
    Configuration menu
    Copy the full SHA
    e072bda View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    2657717 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    67553c8 View commit details
    Browse the repository at this point in the history
  5. Switch to pure "blue"

    asgibson committed Nov 18, 2024
    Configuration menu
    Copy the full SHA
    62b88e5 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    6bc54a9 View commit details
    Browse the repository at this point in the history
  7. Updates for docs

    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 committed Nov 18, 2024
    Configuration menu
    Copy the full SHA
    fb54669 View commit details
    Browse the repository at this point in the history
  8. Configuration menu
    Copy the full SHA
    7bdf5bb View commit details
    Browse the repository at this point in the history
  9. Updates for clarity, content and comparibility

    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
    asgibson committed Nov 18, 2024
    Configuration menu
    Copy the full SHA
    2420865 View commit details
    Browse the repository at this point in the history
  10. Configuration menu
    Copy the full SHA
    620c6f4 View commit details
    Browse the repository at this point in the history

Commits on Nov 19, 2024

  1. Configuration menu
    Copy the full SHA
    9426438 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    2b15957 View commit details
    Browse the repository at this point in the history