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 DQC main page README #114

Conversation

robertandremitchell
Copy link
Collaborator

@robertandremitchell robertandremitchell commented Nov 5, 2024

PULL REQUEST

Summary

This update the main README on the main page of the repo. It is not nearly as comprehensive as the PHDI main page README, but I felt the main things we wanted to keep were the overview/history of DIBBs/PHDI work, an overview of the repo code, and some kind of link to demo/examples people could use.

Definitely will need a much more comprehensive workflow once we have a /redoc equivalent, a separate demo workflow, and the like.

I don't know if we want to take the time for Michelle, Laura, Ryan, and/or Matt to do a fuller review / update of the copy, or if that show take a backseat for now in favor of ensuring the design overall is in a good place.

Related Issue

Fixes #54

Additional Information

Anything else the review team should know?

Checklist

  • Descriptive Pull Request title
  • Link to relevant issues
  • Provide necessary context for design reviewers
  • Update documentation

Copy link

linear bot commented Nov 5, 2024

Copy link
Collaborator

@m-goggins m-goggins 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 taking this on! I added a bit more language to define what it is and what the problem scope is. It doesn't have to be for this PR, but I do think we should pull Matt in for a review of this language.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@robertandremitchell robertandremitchell merged commit 761a449 into main Nov 5, 2024
5 checks passed
@robertandremitchell robertandremitchell deleted the robertamitchell/que-15-update-dibbs-query-connector-readme branch November 5, 2024 21:03
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.

Update dibbs-query-connector README
2 participants