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

[RPD-248] Add a basic example demonstrating how to use the API #199

Merged
merged 4 commits into from
Aug 22, 2023

Conversation

swells2020
Copy link
Contributor

@swells2020 swells2020 commented Aug 17, 2023

This PR updates the Matcha documentation to demonstrate an alternative API implementation for the matcha-examples repo.

Checklist

Please ensure you have done the following:

  • I have read the CONTRIBUTING guide.
  • I have updated the documentation if required.
  • I have added tests which cover my changes.

Type of change

Tick all those that apply:

  • Bug Fix (non-breaking change, fixing an issue)
  • New feature (non-breaking change to add functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (add details above)

@swells2020 swells2020 added the documentation Improvements or additions to documentation label Aug 17, 2023
@swells2020 swells2020 self-assigned this Aug 17, 2023
@swells2020 swells2020 changed the title WIP updates docs [RPD-248] Add a basic example demonstrating how to use the API Aug 21, 2023
Copy link
Member

@Christopher-Norman Christopher-Norman left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@JonoCX JonoCX left a comment

Choose a reason for hiding this comment

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

Nice one - see comments, which I think will improve clarity for readers

docs/getting-started.md Outdated Show resolved Hide resolved
docs/getting-started.md Outdated Show resolved Hide resolved
docs/getting-started.md Outdated Show resolved Hide resolved
@swells2020 swells2020 merged commit e80c19e into develop Aug 22, 2023
@swells2020 swells2020 deleted the RPD-248-add-api-details-to-getting-started branch August 22, 2023 07:31
swells2020 added a commit that referenced this pull request Aug 24, 2023
* [RPD-239] Improve the way the UI handles latency when contacting Azure services (#198)

* [RPD-248] Add a basic example demonstrating how to use the API (#199)

* updates docs

* removes scratch.py

* fixes typos

* updates for comments

* adds cli command to cli module

* fix circular import (#201)

* bumping to version v0.2.9 for release

* adds tests

---------

Co-authored-by: KirsoppJ <40233184+KirsoppJ@users.noreply.github.com>
Co-authored-by: Jonathan Carlton <jonathan.carlton@hotmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants