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.

Sign up for GitHub

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

Jump to bottom

Add docs #153

Merged
merged 4 commits into from
Jan 9, 2025
Merged

Add docs #153

merged 4 commits into from
Jan 9, 2025

Conversation

ka-sarthak
Copy link
Collaborator

@ka-sarthak ka-sarthak commented Jan 9, 2025 •
edited
Loading

Adding docs for transmission and ppms plugin.

@ka-sarthak ka-sarthak requested a review from budschi January 9, 2025 10:18
@ka-sarthak
Copy link
Collaborator Author

@budschi Can you please review it?

@ka-sarthak
Copy link
Collaborator Author

@JonathanNoky I added the available entry points for ppms schema into the README.md. Is this okay?
Also, can we add a brief description of the plugin under docs/index.md#supported-measurement-techniques? You can commit to this branch directly or share as a comment here.

@ka-sarthak ka-sarthak self-assigned this Jan 9, 2025
@JonathanNoky
Copy link
Collaborator

I committed a description to the index.md. And the README.md looks good.

budschi
budschi requested changes Jan 9, 2025
View reviewed changes
Copy link
Contributor

@budschi budschi left a comment

Choose a reason for hiding this comment

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

Thanks for PR. I would just add the "to" and "the"s at the according places

docs/explanation/schemas.md Outdated Show resolved Hide resolved
docs/explanation/schemas.md Outdated Show resolved Hide resolved
docs/explanation/schemas.md Outdated Show resolved Hide resolved
@ka-sarthak ka-sarthak requested a review from budschi January 9, 2025 13:32
@ka-sarthak
Copy link
Collaborator Author

@budschi corrected the docs for grammar. Please approve

budschi
budschi approved these changes Jan 9, 2025
View reviewed changes
Copy link
Contributor

@budschi budschi left a comment

Choose a reason for hiding this comment

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

Perfect!

@budschi budschi merged commit 3cea86c into main Jan 9, 2025
5 checks passed
@ka-sarthak ka-sarthak deleted the add-docs branch January 9, 2025 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@budschi budschi budschi approved these changes

Assignees

@ka-sarthak ka-sarthak

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ka-sarthak @JonathanNoky @budschi