Skip to content

[FA-25] Adding documentation on client-server interaction#13

Merged
scott-clare1 merged 7 commits intomainfrom
FA-25-adding-client-server-documentation
Apr 7, 2025
Merged

[FA-25] Adding documentation on client-server interaction#13
scott-clare1 merged 7 commits intomainfrom
FA-25-adding-client-server-documentation

Conversation

@scott-clare1
Copy link
Contributor

This PR adds documentation on the client server interaction covering how clients and servers establish connections and how the client processes queries made by the user.

Checklist

Please ensure you have done the following:

  • 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)

MacOS tests

To trigger the CI to run on a macOS backed workflow, add the macos-ci-test label to the pull request (PR).

Our advice is to only run this workflow when testing the compatability between operating systems for a change that you've made, e.g., adding a new dependency to the virtual environment.

Note: This can take up to 5 minutes to run. This workflow costs x10 more than a Linux-based workflow, use at discretion.

@scott-clare1 scott-clare1 changed the title Adding documentation on client-server interaction [FA-25] Adding documentation on client-server interaction Apr 4, 2025
@scott-clare1 scott-clare1 self-assigned this Apr 4, 2025
@scott-clare1 scott-clare1 added the documentation Improvements or additions to documentation label Apr 4, 2025
@scott-clare1 scott-clare1 marked this pull request as ready for review April 4, 2025 09:38
@scott-clare1 scott-clare1 requested a review from samgwd April 4, 2025 09:38
@scott-clare1 scott-clare1 requested a review from YazIbrahim April 4, 2025 13:38
@scott-clare1 scott-clare1 requested a review from YazIbrahim April 4, 2025 15:03
@scott-clare1 scott-clare1 merged commit 401fe22 into main Apr 7, 2025
1 check passed
@scott-clare1 scott-clare1 deleted the FA-25-adding-client-server-documentation branch April 7, 2025 12:04
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