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

docs: add about and getting started docs #2838

Draft
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

griest024
Copy link
Member

@griest024 griest024 commented Jun 7, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Other... Please describe:

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

fixes: #2835

@griest024 griest024 added docs This issue is related to documentation status: wip This PR is WIP. It should be marked as a draft. labels Jun 7, 2024
@griest024 griest024 self-assigned this Jun 7, 2024
@@ -1 +1,24 @@
# About Daffodil

Daffodil is a client-side framework for building ecommerce stores. It presents a standard set of interfaces with which the frontend application can interact while offering a selection of drivers that communicate with the platform of choice.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Daffodil is a client-side framework for building ecommerce stores. It presents a standard set of interfaces with which the frontend application can interact while offering a selection of drivers that communicate with the platform of choice.
Daffodil is a client-side framework for building ecommerce stores. It presents a standard set of interfaces with which the frontend application can interact with, along with a selection of drivers that communicate with the platform of choice.

Copy link
Member Author

Choose a reason for hiding this comment

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

This would be grammatically incorrect with the double "with". I changed the wording to be closer to your suggestion though.

Copy link
Member

@xelaint xelaint Feb 19, 2025

Choose a reason for hiding this comment

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

I don't think it's grammatically incorrect?

It presents a standard set of interfaces with which the frontend application can interact.

This sentence definitely needs a with at the end.

If you don't like the double with, it can be:

It presents a standard set of interfaces for frontend applications to interact with, in addition to a selection of drivers that communicate with your platform of choice.

It presents a standard set of interfaces for frontend applications to interact with, along with a selection of drivers that communicate with your platform of choice.

It presents a standard set of interfaces for frontend applications to interact with. It also includes a selection of drivers that communicate with your platform of choice.

Shortened It presents a standard set of interfaces with which the frontend application to It presents a standard set of interfaces for frontend applications to reduce the triple with

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is related to documentation status: wip This PR is WIP. It should be marked as a draft.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Introduction Readme for Daffodil
2 participants