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

Update Documentation #616

Merged
merged 4 commits into from
Aug 12, 2021
Merged

Update Documentation #616

merged 4 commits into from
Aug 12, 2021

Conversation

amlannandy
Copy link
Collaborator

Description

This PR updates the documentation of the project.

  • Most of the documentation has been moved to the Project Wiki with the main readme only containing basic information now.
  • Labeller documentation has also been moved to the Wiki, so its corresponding Readme has been removed.

Fixes #594
Fixes #598

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

N/A

Test Configuration:

N/A

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@amlannandy amlannandy added android Issues and PR regarding android app web Issue and PR regarding web app backend Issue and PR regarding backend GSoC 2021 Tasks related to GSoC 2021 labels Aug 12, 2021
@ThatUdeshUK ThatUdeshUK merged commit 5dfcc44 into scorelab:master Aug 12, 2021
@amlannandy amlannandy deleted the final-docs branch August 13, 2021 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
android Issues and PR regarding android app backend Issue and PR regarding backend GSoC 2021 Tasks related to GSoC 2021 web Issue and PR regarding web app
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the entire web and backend project Document the entire mobile project
2 participants