Skip to content

[Docs]: BlackBox Module README#11

Open
ankitkumar25-rk wants to merge 59 commits into
mainfrom
module/Blackbox
Open

[Docs]: BlackBox Module README#11
ankitkumar25-rk wants to merge 59 commits into
mainfrom
module/Blackbox

Conversation

@ankitkumar25-rk

@ankitkumar25-rk ankitkumar25-rk commented Jul 5, 2026

Copy link
Copy Markdown
Collaborator

Closes #8

Changes

  • Added blackbox/README.md with comprehensive documentation

Checklist

  • Module purpose described
  • Folder structure documented
  • Each source file explained
  • All exported functions with inputs/outputs
  • Telemetry data requirements specified
  • Architecture diagram added
  • How to run + integration test commands
  • Improvements and known limitations

Comment thread os_doctor/documentation.md Outdated
Comment thread README.md

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

No need to do unnecessary changes in this file. Change the architectural diagram.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

done

Comment thread os_doctor/documentation.md Outdated

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Make the changes in os_doctor/README.md and remove this file

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

removed

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.

[Docs]: Blackbox

9 participants