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

Improve dashboard readme #1100

Merged
merged 11 commits into from
Oct 17, 2023
Merged

Improve dashboard readme #1100

merged 11 commits into from
Oct 17, 2023

Conversation

Traxmaxx
Copy link
Contributor

Problem

Readme was slightly outdated and infos where missing

Solution

Provided more test examples, updated reuirements and re-formatted the content.

Changes Made

  • Reformat Readme
  • Add more details about folder aliases
  • Add more details about testing
  • Add one more testing example
  • Update utils test names

How to Test

Screenshots

Notes

Checklist

  • Code follows the contributing guidelines
  • Changes have been thoroughly tested
  • Documentation has been updated, if necessary
  • Any dependencies have been added to the project, if necessary

Reviewers

dashboard/README.md Outdated Show resolved Hide resolved
dashboard/README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@mlabouardy mlabouardy left a comment

Choose a reason for hiding this comment

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

same feedback as @greghub, otherwise all good

@greghub
Copy link
Collaborator

greghub commented Oct 16, 2023

@Traxmaxx thanks a lot! one more small comment, but pre-approved the changes

@greghub
Copy link
Collaborator

greghub commented Oct 16, 2023

@mlabouardy do you think we should include a link to a sample DB and config file to make it easier to run it for contributing?

@mlabouardy
Copy link
Collaborator

@mlabouardy do you think we should include a link to a sample DB and config file to make it easier to run it for contributing?

for sure, we can do it in a separate PR :)

@mlabouardy mlabouardy merged commit 06747b2 into develop Oct 17, 2023
3 checks passed
@mlabouardy mlabouardy deleted the improve-dashboard-readme branch October 17, 2023 10:21
@mlabouardy mlabouardy added this to the v3.1.2 milestone Oct 17, 2023
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.

None yet

3 participants